Merge pull request #278 from geotribu/ci/update-workflows

update(ci): modernize workflows setting GH token scopes and reporting improvements from templater

Author: Guts

.github/workflows/documentation.yml

@@ -1,5 +1,17 @@
 name: "📚 Documentation"
 
+# Global environment variables
+env:
+  CONDITION_IS_PUSH: ${{ github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main') }}
+  CONDITION_IS_WORKFLOW_RUN: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' }}
+  PROJECT_FOLDER: qtribu
+  PYTHON_VERSION: 3.12
+
+# Allow one concurrent deployment per branch/pr
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
@@ -24,20 +36,13 @@ on:
   workflow_dispatch:
 
   workflow_run:
+    branches:
+      - main
     workflows:
       - "📦 Packaging & 🚀 Release"
     types:
       - completed
 
-# Allow one concurrent deployment per branch/pr
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-env:
-  PROJECT_FOLDER: "qtribu"
-  PYTHON_VERSION: 3.9
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
@@ -59,6 +64,14 @@ jobs:
           cache-dependency-path: "requirements/documentation.txt"
           python-version: ${{ env.PYTHON_VERSION }}
 
+      - name: Cache Sphinx cache
+        uses: actions/cache@v4
+        with:
+          path: docs/_build/cache
+          key: ${{ runner.os }}-sphinx-${{ hashFiles('docs/**/*') }}
+          restore-keys: |
+            ${{ runner.os }}-sphinx-
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip setuptools wheel
@@ -70,13 +83,13 @@ jobs:
       - name: Save build doc as artifact
         uses: actions/upload-artifact@v6
         with:
+          if-no-files-found: error
           name: documentation
           path: docs/_build/html/*
-          if-no-files-found: error
           retention-days: 30
 
       - name: Download artifact from build workflow
-        if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
+        if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
         uses: dawidd6/action-download-artifact@v12
         with:
           allow_forks: false
@@ -91,15 +104,15 @@ jobs:
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
-        if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
+        if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4
-        if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
+        if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
         with:
           path: docs/_build/html/
 
       - name: Deploy to GitHub Pages
         id: deployment
-        if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
+        if: ${{ env.CONDITION_IS_PUSH || env.CONDITION_IS_WORKFLOW_RUN }}
         uses: actions/deploy-pages@v4

.github/workflows/linter.yml

@@ -22,6 +22,8 @@ jobs:
     name: Python 🐍
 
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
 
     steps:
       - name: Get source code

.github/workflows/packager.yml

@@ -39,14 +39,16 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
 
-      - name: Install system requirements
+      - name: Install translation requirements
         run: |
           sudo apt update
           sudo apt install qt5-qmake qttools5-dev-tools
           python3 -m pip install -U pyqt5-tools
 
       - name: Update translations
-        run: pylupdate5 -noobsolete -verbose ${{ env.PROJECT_FOLDER }}/resources/i18n/plugin_translation.pro
+        run: |
+          python3 scripts/generate_translation_profile.py
+          pylupdate5 -noobsolete -verbose ${{ env.PROJECT_FOLDER }}/resources/i18n/plugin_translation.pro
 
       - name: Compile translations
         run: lrelease ${{ env.PROJECT_FOLDER }}/resources/i18n/*.ts
@@ -73,9 +75,9 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v6
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
           cache-dependency-path: "requirements/packaging.txt"
+          python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Install project requirements
         run: |
@@ -88,9 +90,6 @@ jobs:
           name: translations-build
           path: ${{ env.PROJECT_FOLDER }}
 
-      - name: List files
-        run: tree ${{ env.PROJECT_FOLDER }}
-
       - name: Amend gitignore to include compiled translations and add it to tracked files
         run: |
           # include compiled translations
@@ -123,6 +122,8 @@ jobs:
   release:
     name: "🚀 Release on tag"
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     needs:
       - translation
 
@@ -135,9 +136,9 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v6
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
           cache-dependency-path: "requirements/packaging.txt"
+          python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Install project requirements
         run: |

.github/workflows/tester.yml

@@ -32,20 +32,24 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
           cache-dependency-path: "requirements/testing.txt"
+          python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Install Python requirements
         run: |
           python -m pip install -U pip setuptools wheel
           python -m pip install -U -r requirements/testing.txt
 
       - name: Run Unit tests
-        run: pytest tests/unit/
+        run: pytest -p no:qgis tests/unit/
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
+        with:
+          env_vars: PYTHON
+          flags: unittests
+          name: Code Coverage for unittests on Ubuntu.python-${{ env.PYTHON_VERSION }}]
 
   test-qgis:
     runs-on: ubuntu-latest
@@ -81,7 +85,7 @@ jobs:
           python3 -m pip install -U -r requirements/testing.txt
 
       - name: Run Unit tests
-        run: pytest tests/qgis/
+        run: pytest tests/qgis --junitxml=junit/test-results-qgis.xml --cov-report=xml:coverage-reports/coverage-qgis.xml
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5