Merge pull request #15 from RomualdRousseau/feature/new-doc-system

fix: Add workflow for github pages

.github/workflows/shuju-monorepo-snapshot.yml

@@ -18,9 +18,3 @@ jobs:
     deploy-snapshot:
         uses: ./.github/workflows/maven-deploy-snapshot.yml
         secrets: inherit
-
-    deploy-doc:
-        needs: [deploy-snapshot]
-        uses: ./.github/workflows/maven-deploy-doc.yml
-        with:
-            version: 1.29-SNAPSHOT

README.md

@@ -82,12 +82,12 @@ Run the following command line:
 mvn -P release clean deploy
 ```
 
-### Build and deploy the javadoc documentation
+### Build the javadoc documentation
 
 Run the following command line:
 
 ```bash
-mvn -P documentation clean site site-deploy
+mvn -P documentation clean site site:stage
 ```
 
 Do not forget to configure the GitHub authentication in ***~/.m2/settings.xml*** as follow:
@@ -99,6 +99,13 @@ Do not forget to configure the GitHub authentication in ***~/.m2/settings.xml***
 </server>
 ```
 
+### Documentation
+
+The following links will give you documentation about some background information, takes you through some implementation details,
+and then focuses on step-by-step instructions for getting the most out of Any2Json:
+
+* API Reference: [here](https://romualdrousseau.github.io/ShuJu-monorepo/).
+
 ## Contribute
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

justfile

@@ -16,44 +16,57 @@ all: initialize test build
 
 # Initializatize maven
 initialize:
-    mvn initialize
+    mvn initialize --also-make
 
 # Clean
 clean:
-    mvn clean
+    mvn clean --also-make
 
 # Build
 build:
-    mvn -DskipTests package
+    mvn -DskipTests package --also-make
 
 # Run the tests
 test:
-    mvn -Dtest=UnitTestSuite -Dsurefire.failIfNoSpecifiedTests=false test
+    mvn -Dtest=UnitTestSuite -Dsurefire.failIfNoSpecifiedTests=false test --also-make
 
 # Run all tests
 test-full:
-    mvn -Dtest=UnitFullTestSuite -Dsurefire.failIfNoSpecifiedTests=false test
+    mvn -Dtest=UnitFullTestSuite -Dsurefire.failIfNoSpecifiedTests=false test --also-make
 
 # Install in the local repository
 install:
-	mvn -DskipTests install
+	mvn -DskipTests install --also-make
 
-# Deploy snapshot
+# Deploy snapshot to the maven repository
 deploy-snapshot:
-	mvn -U -B clean deploy -DskipTests -P snapshot --also-make --batch-mode
+	mvn clean deploy -DskipTests -P snapshot --also-make
 
-# Deploy release
+# Deploy release to the maven repository
 deploy-release:
-	mvn -U -B clean deploy -DskipTests -P release --also-make --batch-mode
+	mvn clean deploy -DskipTests -P release --also-make
 
-# Prepape a new version:
+# Prepape a new version
 prepare-version *args='':
     mvn versions:set -DnewVersion={{args}}
+
+# Commit to the new version
+commit-version:
     mvn versions:commit
 
+# Revert to the previous verison
+revert-version:
+    mvn versions:revert
+
+# Build the documentation
 build-doc:
-    mvn -P documentation clean site site:stage
+    just --justfile any2json-documents/justfile build
+    mvn -P documentation site site:stage
+
+# Update all plugins and dependencies
+update-dependencies:
+    mvn -DcreateChecksum=true versions:display-dependency-updates
 
 # Update all plugins and dependencies
-update:
-    mvn versions:use-latest-release
+update-plugins:
+    mvn -DcreateChecksum=true versions:display-plugin-updates