diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 6bcc4b7e..c34294ee 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -42,14 +42,14 @@ jobs: uses: actions/cache@v3 with: path: ~/.m2/repository - key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} # Cache dependencies based on pom.xml changes + key: ${{ runner.os }}-maven-v2-${{ hashFiles('**/pom.xml') }} # Cache dependencies based on pom.xml changes restore-keys: | - ${{ runner.os }}-maven- + ${{ runner.os }}-maven-v2- # Build the project (compiles and packages the code) - name: Build the project - run: mvn -B -X -e clean install --file pom.xml --batch-mode --fail-fast + run: mvn -B clean install --file pom.xml --batch-mode --fail-fast -Dgpg.skip=true -Dmaven.deploy.skip=true # Run tests - name: Run tests - run: mvn test -B -X -e --file pom.xml --batch-mode --fail-fast + run: mvn test -B --file pom.xml --batch-mode --fail-fast diff --git a/README.md b/README.md index cf2aa782..bd40d963 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,18 @@ This project contains the LiquidJava verifier and its API, as well as some examp You can find out more about LiquidJava in the following resources: -* [Try it](https://github.com/CatarinaGamboa/liquidjava-examples) with GitHub Codespaces or locally -* [VS Code extension for LiquidJava](https://github.com/CatarinaGamboa/vscode-liquidjava) -* [LiquidJava website](https://catarinagamboa.github.io/liquidjava.html) -* [LiquidJava specification examples for the Java standard library](https://github.com/CatarinaGamboa/liquid-java-external-libs) +* [LiquidJava Website](https://catarinagamboa.github.io/liquidjava.html) +* [VS Code Extension (Marketplace)](https://marketplace.visualstudio.com/items?itemName=AlcidesFonseca.liquid-java) +* [VS Code Extension (Source Code)](https://github.com/CatarinaGamboa/vscode-liquidjava) +* [LiquidJava Examples](https://github.com/CatarinaGamboa/liquidjava-examples) +* [LiquidJava External Libraries Examples](https://github.com/CatarinaGamboa/liquid-java-external-libs) ## Getting Started ### VS Code Extension -The easiest way to use LiquidJava is through its [VS Code extension](https://github.com/CatarinaGamboa/vscode-liquidjava), which uses the LiquidJava verifier directly inside VS Code, with error diagnostics and syntax highlighting for refinements. +The easiest way to use LiquidJava is through its [VS Code extension](https://marketplace.visualstudio.com/items?itemName=AlcidesFonseca.liquid-java), which uses the LiquidJava verifier directly inside VS Code, with real-time error diagnostics and syntax highlighting for refinements. ### Command Line @@ -41,6 +42,28 @@ Before setting up LiquidJava, ensure you have the following installed: - Java 20+ - JDK for compiling and running Java programs - Maven 3.6+ - For building and dependency management +Additionally, you'll need the following dependency, which includes the LiquidJava API annotations: + +#### Maven +```xml + + io.github.rcosta358 + liquidjava-api + 0.0.3 + +``` + +#### Gradle +```groovy +repositories { + mavenCentral() +} + +dependencies { + implementation 'io.github.rcosta358:liquidjava-api:0.0.3' +} +``` + #### Setup 1. Clone the repository: `git clone https://github.com/CatarinaGamboa/liquidjava.git` diff --git a/liquidjava-api/pom.xml b/liquidjava-api/pom.xml index a0ff0e4b..bddf1a36 100644 --- a/liquidjava-api/pom.xml +++ b/liquidjava-api/pom.xml @@ -3,50 +3,150 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - - liquidjava - liquidjava-umbrella - 1.0 - - - liquidjava-api + io.github.rcosta358 liquidjava-api - 0.0.2-SNAPSHOT + 0.0.3 liquidjava-api + LiquidJava API + https://github.com/CatarinaGamboa/liquidjava jar + + + MIT License + https://opensource.org/licenses/MIT + repo + + + + + + CatarinaGamboa + Catarina Gamboa + CatarinaGamboa@users.noreply.github.com + https://github.com/CatarinaGamboa + + + alcides + Alcides Fonseca + alcides@users.noreply.github.com + https://github.com/alcides + + + rcosta358 + Ricardo Costa + rcosta358@users.noreply.github.com + https://github.com/rcosta358 + + + + + scm:git:git://github.com/CatarinaGamboa/liquidjava.git + scm:git:ssh://github.com:CatarinaGamboa/liquidjava.git + https://github.com/CatarinaGamboa/liquidjava/tree/main + + - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.8.1 - - 20 - 20 - - - - + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 20 + 20 + + + + + + org.apache.maven.plugins + maven-source-plugin + 3.3.0 + + + attach-sources + + jar-no-fork + + + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.6.0 + + + attach-javadocs + + jar + + + + + none + 20 + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 3.1.0 + + ${gpg.skip} + + + + sign-artifacts + verify + + sign + + + + + + + + org.apache.maven.plugins + maven-deploy-plugin + 3.1.2 + + true + + + + + + org.sonatype.central + central-publishing-maven-plugin + 0.9.0 + true + + central + ${maven.deploy.skip} + + + + + + + central + https://central.sonatype.com/api/v1/publisher + + + + UTF-8 20 20 20 - + \ No newline at end of file diff --git a/liquidjava-example/pom.xml b/liquidjava-example/pom.xml index 10b8aadf..a019cc82 100644 --- a/liquidjava-example/pom.xml +++ b/liquidjava-example/pom.xml @@ -48,9 +48,9 @@ ${version.memcompiler} - liquidjava-api + io.github.rcosta358 liquidjava-api - 0.0.2-SNAPSHOT + 0.0.3 diff --git a/liquidjava-verifier/pom.xml b/liquidjava-verifier/pom.xml index 21464fa3..93a0dff2 100644 --- a/liquidjava-verifier/pom.xml +++ b/liquidjava-verifier/pom.xml @@ -172,9 +172,9 @@ - liquidjava-api + io.github.rcosta358 liquidjava-api - 0.0.2-SNAPSHOT + 0.0.3 @@ -199,11 +199,6 @@ pom import - - liquidjava-api - liquidjava-api - 0.0.2-SNAPSHOT -