Move report reference document generation into a separate action

Author: JohT

.github/workflows/report-reference-documentation.yml

@@ -0,0 +1,65 @@
+name: Generate report reference documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'results/**' # Only run results have been updates
+      - '.github/workflows/report-reference-documentation.yml' # or when this file was changed
+    paths-ignore:
+      - 'results/*.md' # Ignore report reference documentation changes
+  pull_request:
+    branches:
+      - main
+    paths: 
+      - 'results/**' # Only run results have been updates
+      - '.github/workflows/report-reference-documentation.yml' # or when this file was changed
+    paths-ignore:
+       - 'results/*.md' # Ignore report reference documentation changes
+  
+jobs:
+  reports:
+    runs-on: ubuntu-latest
+    env: 
+      CI_COMMIT_MESSAGE: Automated report reference document generation (CI)
+      CI_COMMIT_AUTHOR: ${{ github.event.repository.name }} Continuous Integration
+
+    steps:
+    - name: Checkout git repository
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}
+  
+    - name: Generate report reference document
+      working-directory: results
+      run: |
+        ./../scripts/documentation/generateReportReferences.sh
+
+    - name: Archive generated report reference document
+      uses: actions/upload-artifact@v4
+      with:
+        name: report-reference-document
+        path: ./results/*.md
+        if-no-files-found: error
+        retention-days: 5
+
+    - name: Use git to detect changes in the regenerated documenta and set generated_document_changed
+      run: git diff --quiet || echo "generated_document_changed=true" >> $GITHUB_ENV
+
+    - name: Display generated_document_changed
+      run: echo "generated_document_changed=${{ env.generated_document_changed}}"
+
+    - name: Commit generated report reference document if there were changes
+      # Only run when a pull request gets merged or a commit is pushed to the main branch.
+      # And only run when the generated document changed to avoid an empty commit or an error while committing.
+      if: github.event_name == 'push' && env.generated_document_changed
+      run: |
+        git config --global user.name '${{ env.CI_COMMIT_AUTHOR }}'
+        git config --global user.email '[email protected]'
+        set -o errexit -o pipefail -o xtrace
+        git add ./results/*.md
+        git status
+        git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
+        git status
+        git push --verbose

scripts/copyReportsIntoResults.sh

@@ -41,13 +41,4 @@ for report_source_folder in **/"${REPORTS_DIRECTORY}"; do
 
     rm -rf "${reportTargetDirectory}"
     cp -Rp "${report_source_folder}" "${reportTargetDirectory}"
-done
-
-# Generate JUPYTER_REPORTS.md containing a reference to all Jupyter Notebook Markdown reports in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateJupyterReportReference.sh")
-
-# Generate CSV_REPORTS.md containing a reference to all CSV cypher query reports in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateCsvReportReference.sh")
-
-# Generate IMAGES.md containing a reference to all PNG images in the "results" directory and its subdirectories.
-(cd "./../${RESULTS_DIRECTORY}" && exec "${SCRIPTS_DIR}/documentation/generateImageReference.sh")
+done

scripts/documentation/generateReportReferences.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Triggers the regeneration of all reference documentations for the reports inside the "results" directory.
+# The generation to the reference documentations is delegated to the dedicated scripts.
+
+# Notice that this scripts needs to be executed within the "results" directory.
+
+# Requires generateJupyterReportReference.sh, generateCsvReportReference.sh, generateImageReference.sh
+
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -o errexit -o pipefail
+
+# Generate JUPYTER_REPORTS.md containing a reference to all Jupyter Notebook Markdown reports in the "results" directory and its subdirectories.
+source "${DOCUMENTATION_SCRIPT_DIR}/generateJupyterReportReference.sh"
+
+# Generate CSV_REPORTS.md containing a reference to all CSV cypher query reports in the "results" directory and its subdirectories.
+source "${DOCUMENTATION_SCRIPT_DIR}/generateCsvReportReference.sh"
+
+# Generate IMAGES.md containing a reference to all PNG images in the "results" directory and its subdirectories.
+source "${DOCUMENTATION_SCRIPT_DIR}/generateImageReference.sh"