Merge pull request music-encoding#1580 from music-encoding/release/v5.1

Release v5.1, the second
musicEnfanthen · Jan 22, 2025 · 9d551da · 9d551da
2 parents eb14650 + 09b60ce
commit 9d551da
Show file tree

Hide file tree

Showing 175 changed files with 4,165 additions and 1,884 deletions.
diff --git a/.github/pr-labeler_config.yml b/.github/pr-labeler_config.yml
@@ -1,29 +1,35 @@
-"Component: Build":
-- build.xml
+'Component: Build':
+  - changed-files:
+    - any-glob-to-any-file: ['build.xml']
 
-"Component: Core Schema":
-- source/modules/**/*
-- source/mei-source.xml
+'Component: Core Schema':
+  - changed-files:
+    - any-glob-to-any-file: ['source/modules/**/*', 'source/mei-source.xml']
 
-"Component: Customizations":
-- customizations/**/*
+'Component: Customizations':
+  - changed-files:
+    - any-glob-to-any-file: ['customizations/**/*']
 
-"Component: Guidelines & Documentation":
-- source/docs/**/*
-- source/examples/**/*
-- source/web/**/*
+'Component: Guidelines & Documentation':
+  - changed-files:
+    - any-glob-to-any-file: ['source/docs/**/*', 'source/examples/**/*']
 
-"Component: Images":
-- source/images/**/*
+'Component: Images':
+  - changed-files:
+    - any-glob-to-any-file: ['source/assets/images/**/*']
 
-"Component: Style":
-- source/assets/css/**/*
+'Component: Style':
+  - changed-files:
+    - any-glob-to-any-file: ['source/assets/css/**/*']
 
-"Component: Utils":
-- utils/**/*
+'Component: Utils':
+  - changed-files:
+    - any-glob-to-any-file: ['utils/**/*']
 
-"Component: Validation":
-- source/validation/**/*
+'Component: Validation':
+  - changed-files:
+    - any-glob-to-any-file: ['source/validation/**/*']
 
-"Component: Workflows":
-- .github/workflows/**/*
+'Component: Workflows':
+  - changed-files:
+    - any-glob-to-any-file: ['.github/**/*']
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -56,7 +56,7 @@ jobs:
 
       ### BUIDLING THE SCHEMA AND THE GUIDELINES ###
       - name: Checkout main repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           # Whether to checkout submodules: `true` to checkout submodules or `recursive` to
           # recursively checkout submodules.
@@ -72,13 +72,13 @@ jobs:
 
       ### UPLOADING THE ARTIFACTS ###
       - name: Upload PDF
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         with:
           name: pdf
           path: ${{ github.workspace }}/dist/guidelines/pdf/MEI_Guidelines_*.pdf
 
       - name: Upload Prince XML log
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         with:
           name: prince_log
           path: ${{ github.workspace }}/build/prince.log
@@ -112,7 +112,7 @@ jobs:
       ### PUBLISHING THE SCHEMA ###
       - name: Checkout SCHEMA_REPO into SCHEMA_DIR
         if: github.repository_owner == env.REPO_OWNER && env.IS_DEV_OR_TAG == 'true'
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           # repository to check out
           repository: ${{ env.SCHEMA_REPO }}
@@ -140,7 +140,10 @@ jobs:
           rm -rf $SCHEMA_DIR/$TARGET_DIR
           cp -r dist/schemata/ $SCHEMA_DIR/
           mv $SCHEMA_DIR/schemata $SCHEMA_DIR/$TARGET_DIR
-          cp -r build/mei-source_canonicalized.xml $SCHEMA_DIR/$TARGET_DIR
+      
+      - name: Copy mei-source_canonicalized to SCHEMA_DIR
+        if: github.repository_owner == env.REPO_OWNER && env.IS_DEV_OR_TAG == 'true'
+        run: find ${{ github.workspace }}/build -name 'mei-source_canonicalized_*.xml' -exec cp {} $SCHEMA_DIR/$TARGET_DIR/ \;
 
       - name: Check git status before commit
         if: github.repository_owner == env.REPO_OWNER && env.IS_DEV_OR_TAG == 'true'
@@ -173,7 +176,7 @@ jobs:
       ### PUBLISHING THE GUIDELINES ###
       - name: Checkout GUIDELINES_REPO into GUIDELINES_DIR
         if: github.repository_owner == env.REPO_OWNER && env.IS_DEV_OR_TAG == 'true'
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           # repository to check out
           repository: ${{ env.GUIDELINES_REPO }}
@@ -239,7 +242,7 @@ jobs:
       # but then the version would have to be determined programatically
       - name: Create release
         if: startsWith(github.ref, 'refs/tags/v')
-        uses: ncipollo/release-action@6c75be85e571768fa31b40abf38de58ba0397db5 # ratchet:ncipollo/release-action@v1.13.0
+        uses: ncipollo/release-action@cdcc88a9acf3ca41c16c37bb7d21b9ad48560d87 # v1.15.0
         with:
           allowUpdates: false
           artifacts: "${{ github.workspace }}/dist/guidelines/pdf/MEI_Guidelines_${{ github.ref_name }}.pdf"

diff --git a/.github/workflows/pr-labeler.yml b/.github/workflows/pr-labeler.yml
@@ -16,10 +16,13 @@ on:
 
 jobs:
   label:
+    permissions:
+      contents: read
+      pull-requests: write
     runs-on: ubuntu-latest
     if: github.repository_owner == 'music-encoding'
     steps:
-    - uses: actions/labeler@v4
+    - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"
         sync-labels: true

diff --git a/.gitmodules b/.gitmodules
diff --git a/BUILD_COMMANDLINE.md b/BUILD_COMMANDLINE.md
@@ -7,11 +7,12 @@
    | Prerequisite | Recommended version |
    |----|----------------|
    |Java| Java Development Kit (JDK) 17 recommended (at least Java 8 at runtime to support Apache Ant™)|
-   |Apache Ant|1.10.13|
-   |Verovio Toolkit|3.15|
-   |Prince XML|15.1|
-   |Saxon HE*| 11.5 |
-   |Xerces*|Synchrosoft patched version 25.1.0.1|
+   |Apache Ant|1.10.14|
+   |Verovio Toolkit|4.2.1|
+   |Prince XML|15.3|
+   |Saxon HE*|12.5|
+   |TEI Stylesheets*|7.57.1|
+   |Xerces*|Synchrosoft patched version 26.1.0.1|
 
    \* automatically pulled during build execution
 
@@ -49,7 +50,7 @@
      This should return something similar to:
 
      ```shell
-     Apache Ant™ version 1.10.13 compiled on September 27 2020
+     Apache Ant(TM) version 1.10.14 compiled on August 16 2023
      ```
 
      We recommend using the latest stable release of Apache Ant™. If your system has an older version of Apache Ant™ installed you might still give it a try though. If the prompt returns an empty string, please refer to the [Apache Ant™ Installation Instructions](https://ant.apache.org/manual/install.html) or any other applicable installation instruction.
@@ -143,15 +144,17 @@ The following targets can be called using `ant <target>`:
 | target                | description     |
 |-----------------------|-----------------|
 | `dist` (or no target) | Default main target; equivalent to calling ant without any target. Builds all artifacts, i.e., RNG and compiled ODDs of all customizations, guidelines html and PDF.  |
-| `canonicalize-source` | Creates a canonicalized version of the mei-source.xml, i.e., resolves xincludes and puts result in `build/mei-source_canonicalized`. This target will be triggered before all `build-...` targets. |
+| `canonicalize-source` | Creates a canonicalized version of the mei-source.xml, i.e., resolves xincludes and puts result in `build/mei-source_canonicalized_v{mei-version}`. |
+| `validate-source` | Validates the canonicalized source. This target will be triggered before all `build-...` targets. |
 | `build-compiled-odds` | Builds the compiled ODD files for all MEI customizations. |
 | `build-compiled-odd -Dcustomization.path="[ABSOLUTE/PATH/TO/YOUR/CUSTOMIZATION]"` | Builds the compiled ODD of a specific customization submitted as as absolute path with `-Dcustomization.path` input param. |
 | `build-customizations` | Builds the RNG schemata for all MEI customizations. |
 | `build-rng -Dcustomization.path="[ABSOLUTE/PATH/TO/YOUR/CUSTOMIZATION]"` | Builds the RNG schema of a specific customization submitted as absolute path with `-Dcustomization.path` input param. |
 | `build-guidelines-html` | Builds the HTML version of the MEI guidelines. |
 | `build-guidelines-pdf` | Builds the PDF version of the MEI guidelines. (Calls `build-guidelines-html` before execution.) |
-| `init` | Initializes the build environment, i.e., checks if saxon and xerces are available, and if not, downloads jar files for Saxon, Xerces and adds them to the `lib` folder. Checks if prince is available. |
+| `info`| Displays the versions of Ant and Java (JDK). |
+| `init` | Initializes the build environment, i.e., checks if TEI Stylesheets, Saxon, Xerces and Schematron are available, and if not, it downloads everything into the `lib` folder. Checks if Prince is available. |
 | `init-mei-classpath` | Initializes the mei.classpath, which is essential for the schema generation, by prepending the jar files contained in the lib directory to the java classpath. Will be called automatically if needed. |
 | `compare-versions` | Compares the canonicalized sources of the MEI dev version with the previous stable version and creates an HTML output; custom versions and output folder can be set via `-Dsource`, `-Dold` and `-Doutput` input params. |
 | `clean` | Deletes the following directories: `build`, `dist` and `temp`. |
-| `reset` | Resets the build environment. Same as `clean`, but additionaly deletes the `lib` directory with the Saxon and Xerces jar files. |
+| `reset` | Resets the build environment. Same as `clean`, but additionally deletes the `lib` directory with the TEI Stylesheets and the jar files. |
diff --git a/BUILD_OXYGEN.md b/BUILD_OXYGEN.md
@@ -8,7 +8,7 @@ To build the RNG schema of a specific customization, follow these steps:
 
 1. Open the customization file in oXygen.
 
-   To make sure that step 2 works out of the box, make sure that it has the extension `.odd` and not `.xml`. This is necessary for oXygen to recognize the file as TEI ODD customization and offer you the preconfigured transformation scenario for generating RNG schema files from an ODD.
+   To make sure that step 2 works out of the box, make sure that it has the extension `.odd` and not `.xml`. This is necessary for oXygen to recognize the file as TEI ODD customization and offer you the pre-configured transformation scenario for generating RNG schema files from an ODD.
 
 2. Click on the _Configure Transformation Scenario(s)_ button (the red play button with the wrench). This will open a window of the same name.