Fix workflow bugs (#61)

* Update release.yml

- Add R2021b and R2022a to test matrix
- Support workflow dispatch event
- Skip code coverage upload

* Add job to abort if the tag commit is a retag

* Support two event modes for triggering the release workflow

* Add fallback for function not existing until R2023b

* Update MetaTypeRegistry.m

* Update TutorialTest.m

- Use relative path name as the test parameter.

* Update Collection.m

Fix retrieval of instance keys for R2022b and R2023a

* Update release.yml

Add conditional tag deletion

* Update release.yml

* Update release.yml

* Update updateCodeMetaFile.m

Ensure author is an array in the final json

* Update MLToolboxInfo.json

* Update updateCodeMetaFile.m

* Update README.md

* Fix/suppress code issues

* Fix suppressed code issues

* Update run_tests.yml

* Update code issues and tests badges

* Add email adress to workflow commits

* Update workflow files

Replace , with ; for command separation in MATLAB commands
Move steps for better logical step sequence
Fetch tags before potentially retagging to make sure tags are present locally
Add skip-ci tag to commit message in release workflow

* Update release.yml

Change step name to avoid using the same name as in the first job

---------

Co-authored-by: Run tests by ehennestad <>

Author: ehennestad

.github/badges/code_issues.svg

@@ -87,7 +87,7 @@ jobs:
         with:
           command: |
             addpath(genpath("tools"));
-            testToolbox('ReportSubdirectory',"${{ matrix.MATLABVersion }}", 'CreateBadge', false)     
+            testToolbox('ReportSubdirectory', "${{ matrix.MATLABVersion }}", 'CreateBadge', false)
 
       # Save the contents of the report directory from each release into an artifact.
       - name: Save report directory
@@ -129,7 +129,36 @@ jobs:
       - name: Generate tested with badge
         uses: matlab-actions/run-command@v2
         with:
-          command: addpath(genpath("tools")), createTestedWithBadgeforToolbox("${{ env.VERSION_TAG }}")     
+          command: | 
+            addpath(genpath("tools")); 
+            createTestedWithBadgeforToolbox("${{ env.VERSION_TAG }}")     
+
+      # Check out the gh-badges in a separate folder to commit the JSON badge
+      - name: Checkout gh-badges branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-badges
+          path: gh-badges
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      # Push the JSON badge to the gh-badges (if changes were detected)
+      - name: Push to gh-badges
+        run: |
+          mkdir -p gh-badges/.github/badges/${{ env.VERSION_TAG }}
+          cp .github/badges/${{ env.VERSION_TAG }}/tested_with.json gh-badges/.github/badges/${{ env.VERSION_TAG }}/tested_with.json
+          cd gh-badges
+
+          git config user.name "${{ github.workflow }} by ${{ github.actor }}"
+          git config user.email "${{ secrets.COMMIT_EMAIL_ADDRESS }}"
+
+          # Only proceed with commit and push if changes are detected
+          if [[ $(git add .github/badges/* --dry-run | wc -l) -gt 0 ]]; then
+            git add .github/badges/*
+            git commit -m "Update tested with badge for release"
+            git push -f
+          else
+            echo "Nothing to commit"
+          fi
 
       # Publish test results from all the releases
       - name: Publish test results
@@ -142,11 +171,13 @@ jobs:
       - name: Package toolbox
         uses: matlab-actions/run-command@v2
         with:
-          command: addpath(genpath("tools")), packageToolbox("specific","${{ env.VERSION_TAG }}")     
+          command: |
+            addpath(genpath("tools"));
+            packageToolbox("specific", "${{ env.VERSION_TAG }}")
 
       # Define the versionNumber using underscores, as this is used in the MLTBX
-      - name: Set version number
-        id: set_version
+      - name: Format version tag with underscores and add to environment
+        id: set_version_with_underscores
         run: |
           versionNumber=$(echo "${{ env.VERSION_TAG }}" | sed 's/\./_/g')
           echo "versionNumber=$versionNumber" >> $GITHUB_ENV
@@ -165,52 +196,29 @@ jobs:
             addpath(genpath("tools"));
             updateCodeMetaFile("${{ env.VERSION_TAG }}")
 
-      # Commit the updated Contents.m
-      - name: Commit updated Contents.m file
+      # Commit the updated Contents.m and codemeta.json
+      - name: Commit updated Contents.m and codemeta.json files
         continue-on-error: true
         run: |
           git config user.name "${{ github.workflow }} by ${{ github.actor }}"
-          git config user.email "<>"
+          git config user.email "${{ secrets.COMMIT_EMAIL_ADDRESS }}"
           git status
           git add code/Contents.m
           git add codemeta.json
-          git commit -m "Final checkins for release ${{ env.VERSION_TAG }}"
+          git commit -m "Final check-ins for release ${{ env.VERSION_TAG }} [skip-ci]"
           git fetch
           git push
 
-      # Commit the JSON for the MATLAB releases test badge to gh-badges branch
-      - name: Checkout gh-badges branch
-        uses: actions/checkout@v4
-        with:
-          ref: gh-badges
-          path: gh-badges
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Push to gh-badges
-        run: |
-          mkdir -p gh-badges/.github/badges/${{ env.VERSION_TAG }}
-          cp .github/badges/${{ env.VERSION_TAG }}/tested_with.json gh-badges/.github/badges/${{ env.VERSION_TAG }}/tested_with.json
-          cd gh-badges
-
-          git config user.name "${{ github.workflow }} by ${{ github.actor }}"
-          git config user.email "<>"
-
-          # Only proceed with commit and push if changes are detected
-          if [[ $(git add .github/badges/* --dry-run | wc -l) -gt 0 ]]; then
-            git add .github/badges/*
-            git commit -m "Update tested with badge for release"
-            git push -f
-          else
-            echo "Nothing to commit"
-          fi
+      - name: Fetch tags
+        run: git fetch --tags
 
       # (Re)tag the repo so that the updated files are included in the release tag
       - name: Update tag
         if: always()
         continue-on-error: true
         run: |
           git config user.name "${{ github.workflow }} by ${{ github.actor }}"
-          git config user.email "<>"
+          git config user.email "${{ secrets.COMMIT_EMAIL_ADDRESS }}"
 
           # Delete the existing tag locally and remotely if it already exists
           if git rev-parse --verify "refs/tags/${{ env.VERSION_TAG }}" > /dev/null 2>&1; then

.github/badges/tests.svg

@@ -9,6 +9,8 @@ on:
     paths-ignore:
       - '*.md'
       - '.github/**'
+      - '**/Contents.m'
+      - '**/codemeta.json'
   pull_request:
     branches: [ "main" ]
   # Allows for manually running this workflow from the Actions tab
@@ -31,6 +33,8 @@ jobs:
       # Checks-out the repository under $GITHUB_WORKSPACE, so the job can access it
       - name: Check out repo
         uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref_name }}
 
       - name: Set up MATLAB
         uses: matlab-actions/setup-matlab@v2
@@ -42,7 +46,7 @@ jobs:
         if: matrix.MATLABVersion == env.LatestMATLABVersion
         uses: matlab-actions/run-command@v2
         with:
-          command: addpath(genpath("tools")),codecheckToolbox()
+          command: addpath(genpath("tools")); codecheckToolbox()
 
       # Upload code issues report
       - name: Upload SARIF file
@@ -61,15 +65,15 @@ jobs:
         with:
           command: |
             doCreateBadge = "${{ matrix.MATLABVersion }}" == "${{ env.LatestMATLABVersion }}";
-            addpath(genpath("tools")), testToolbox("CreateBadge", doCreateBadge)
+            addpath(genpath("tools")); testToolbox("CreateBadge", doCreateBadge)
 
       # Commit updated SVG badges for the issues and tests (if changed)
       - name: Commit svg badges if updated
         if: matrix.MATLABVersion == env.LatestMATLABVersion
         continue-on-error: true
         run: |
           git config user.name "${{ github.workflow }} by ${{ github.actor }}"
-          git config user.email "<>"
+          git config user.email "${{ secrets.COMMIT_EMAIL_ADDRESS }}"
           git fetch
 
           if [[ $(git add .github/badges/* --dry-run | wc -l) -gt 0 ]]; then