Merge pull request #66 from OP-TED/release/1.13.0

Prepare release of version 1.13.0

.github/workflows/publish.yml

@@ -1,4 +1,5 @@
-name: Publish package to GitHub Packages
+name: Publish package to the Maven Central Repository
+
 on:
   push:
     branches:
@@ -15,14 +16,25 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: read
-      packages: write
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
+      - name: Import GPG Key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+      - name: Set up Java for publishing to Maven Central Repository
+        uses: actions/setup-java@v4
         with:
           java-version: '11'
           distribution: 'adopt'
-      - name: Publish package
-        run: mvn --batch-mode deploy
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+      - name: Publish to the Maven Central Repository
+        run: mvn --batch-mode deploy -Prelease
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+

README.md

@@ -3,6 +3,8 @@
 The eForms SDK Analyzer is a command-line application for the static analysis of the content of the eForms SDK.
 It loads the files from the eForms SDK, and applies various checks and verifications, to try to ensure that their content is correct and consistent.
 
+It can also run a benchmark of the Schematron rules in an eForms SDK, to help detect potential performance issues in those validation rules.
+
 ## Building
 
 Requirements:
@@ -18,7 +20,9 @@ mvn clean package
 
 ## Usage
 
-To run the application, execute the runnable JAR built as described above, indicating the path to the folder containing the eForms-SDK:
+### SDK Analysis
+
+To analyze the content of an eForms SDK, execute the runnable JAR built as described above, indicating the path to the folder containing the eForms SDK:
 
 ```shell
 java -jar target/eforms-sdk-analyzer-1.8.0-SNAPSHOT.jar path/to/eforms-sdk
@@ -28,6 +32,18 @@ This will return the exit code 0 if no errors are found, and 1 otherwise.
 
 Any error or warning found during the analysis will be logged at the corresponding level. By default, logs go to the standard output.
 
+### Schematron rules benchmark
+
+To run the benchmark of the Schematron rules in an eForms SDK, execute the runnable JAR built as described above, indicating the path to the folder containing the eForms SDK and the command `benchmark`:
+
+```shell
+java -jar target/eforms-sdk-analyzer-1.8.0-SNAPSHOT.jar path/to/eforms-sdk benchmark
+```
+
+This will execute the Schematron rules on a few large XML notices included as resources in this project, with an appropriate warm-up and number of iterations. The results are written to a JSON file.
+
+You can compare those results with the ones from another SDK version, to detect whether the rules have become slower to execute.
+
 ## Contributing
 
 ### Adding a check