Shared actions 🔥

.github/actions/notify_testing_matrix/action.yml

@@ -0,0 +1,28 @@
+name: 'Notify Matrix Chat'
+description: 'Send a message to a Matrix chat room'
+inputs:
+  matrix_token:
+    description: 'The token to use to authenticate with the Matrix server'
+    required: true
+  subject:
+    description: 'Subject of the message'
+    default: 'no subject'
+  release_type:
+    description: 'Type of the release'
+    required: true
+  version:
+    description: 'The version of the release'
+    default: "version unknown"
+  repository:
+    description: 'The repository that triggered the action'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Send message to Matrix
+      uses: fadenb/matrix-chat-message@v0.0.6
+      with:
+        homeserver: 'matrix.org'
+        token: ${{ inputs.matrix_token }}
+        channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org'
+        message: "Testing QA phase in repo ${{ inputs.repository }} of a ${{ inputs.release_type }} release (${{ inputs.version }}) started. Subject to test: ${{ inputs.subject }}"

.github/workflows/auto_translate.yml

@@ -0,0 +1,58 @@
+name: Auto translate
+on:
+  workflow_call:
+    inputs:
+      branch:
+        description: 'The branch to checkout and run the action in'
+        type: string
+        default: ${{ github.ref }}
+      action_branch:
+        description: 'The shared action branch to checkout'
+        type: string
+        default: main
+      python_version:
+        description: 'The python version to use'
+        type: string
+        default: "3.8"
+      locale_folder:
+        description: 'The base folder to look for localization files'
+        type: string
+        default: locale
+
+
+jobs:
+  autotranslate:
+    env:
+      API_KEY: ${{secrets.DL_API_KEY}}
+      LOCALE_FOLDER: ${{ github.workspace }}/action/package/${{ inputs.locale_folder }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GH_PAT }}
+          ref: ${{ inputs.branch }}
+          path: action/package/
+      - name: Checkout Scripts Repo
+        uses: actions/checkout@v4
+        with:
+          repository: OpenVoiceOS/.github
+          ref: ${{ inputs.action_branch }}
+          path: action/github/
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ inputs.python_version }}
+      - name: Install Translate Tools
+        run: |
+          python -m pip install -r action/github/requirements/pip_translation.txt
+      - name: Auto Translate
+        run: |
+          python action/github/scripts/translate.py
+      - name: Commit to dev
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "fix(localisation): autotranslate common languages"
+          repository: action/package/

.github/workflows/check_conventional_commits.yml

@@ -0,0 +1,59 @@
+name: License Tests
+on:
+  workflow_call:
+    inputs:
+      runner:
+        description: 'Runner to use'
+        type: string
+        default: 'ubuntu-latest'
+      branch:
+        description: 'Branch to check out'
+        type: string
+        default: ${{ github.ref }}
+      action_branch:
+        description: 'Branch to check out'
+        type: string
+        default: main
+      custom_labels:
+        description: 'Custom labels to use'
+        type: string
+        default: '{}'
+      pr_number:
+        description: 'Optional pull request number'
+        type: string
+        default: ''
+      error_on_failure:
+        description: 'Throws an error if the title not adheres to Conventional Commit format or testing phase is ongoing'
+        type: boolean
+        default: false
+
+jobs:
+  validate-pr-title:
+    runs-on: ${{ inputs.runner }}
+    env:
+      GH_PAT: ${{ secrets.GH_PAT }}
+      GITHUB_REPOSITORY: ${{ github.repository }}
+      PR_LABELS: ${{ inputs.custom_labels }}
+      PR_NUMBER: ${{ inputs.pr_number }}
+      ERROR_ON_FAILURE: ${{ inputs.error_on_failure }}
+      TEST_PHASE_CACHE: ${{ github.workspace }}/test-status
+      PCCC_CONFIG_FILE: ${{ github.workspace }}/pccc.toml
+    steps:
+      - name: Checkout Scripts Repo
+        uses: actions/checkout@v4
+        with:
+          repository: OpenVoiceOS/.github
+          ref: ${{ inputs.action_branch }}
+      - name: Install Python Requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ${{ github.workspace }}/requirements/pip_base.txt
+      - name: Get Cached Test Status
+        uses: actions/cache@v2
+        with:
+          path: test-status
+          key: test-status-${{ runner.os }}
+      - name: Status Check
+        run: |
+          python scripts/check_PRs.py
+

.github/workflows/check_supported_py_versions.yml

@@ -0,0 +1,25 @@
+name: Check Supported Python Versions
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  update-versions:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Run Python Version Check Script
+      run: 
+        python scripts/check_supported_py_versions.py
+    - name: Commit and Push if Changes
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "github-actions[bot]@users.noreply.github.com"
+        git add supported_py_versions.json
+        git commit -m "Update Supported Python Versions" || exit 0  # Exit gracefully if no changes
+        git push

.github/workflows/clear_test_phase.yml

@@ -0,0 +1,33 @@
+on:
+  workflow_call:
+
+jobs:
+  clear_test_flag:
+    runs-on: ubuntu-latest
+    # set cached test status to complete
+    steps:
+      - name: Set test status
+        run: |
+          echo "complete" > test-status
+      - name: Delete Test Tracking Cache
+        run: |
+          gh extension install actions/gh-actions-cache
+
+          echo "Fetching list of cache key"
+          cacheKeys=$(gh actions-cache list -R ${{ github.repository }} -L 100 | cut -f 1 )
+
+          ## Setting this to not fail the workflow while deleting cache keys.
+          set +e
+          echo "Deleting caches..."
+          for cacheKey in $cacheKeys
+          do
+              gh actions-cache delete $cacheKey -R ${{ github.repository }} --confirm
+          done
+          echo "Done"
+        env:
+          GH_TOKEN: ${{ secrets.GH_PAT }}
+      - name: Cache test status
+        uses: actions/cache@v2
+        with:
+          path: test-status
+          key: test-status-${{ runner.os }}

.github/workflows/license_tests.yml

@@ -0,0 +1,97 @@
+name: License Tests
+on:
+  workflow_call:
+    inputs:
+      runner:
+        description: 'Runner to use'
+        type: string
+        default: 'ubuntu-latest'
+      branch:
+        description: 'Branch to check out'
+        type: string
+        default: ${{ github.ref }}
+      action_branch:
+        description: 'The shared action branch to checkout'
+        type: string
+        default: main
+      python_version:
+        description: 'Python version to use'
+        type: string
+        default: '3.8'
+      system_deps:
+        description: 'Additional system dependencies (whitespace delimited) to install'
+        required: false
+        type: string
+      pip_packages:
+        description: 'Additional Python packages (whitespace delimited) to install'
+        type: string
+        required: false
+      install_extras:
+        description: 'Optional extras to install the python package with'
+        required: false
+        type: string
+      packages-exclude:
+        description: 'Regex to exclude packages from the license check'
+        type: string
+        default: '^(precise-runner|fann2|tqdm|bs4|nvidia|bitstruct).*'
+      licenses-exclude:
+        description: 'Regex to exclude licenses from the license check'
+        type: string
+        default: '^(Mozilla).*$'
+jobs:
+  license_tests:
+    timeout-minutes: 15
+    runs-on: ${{ inputs.runner }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.branch }}
+          path: action/package/
+      - name: Checkout Scripts Repo
+        uses: actions/checkout@v4
+        with:
+          path: action/github/
+          ref: ${{ inputs.action_branch }}
+          repository: OpenVoiceOS/.github
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ inputs.python_version }}
+      - name: Install Custom System Dependencies
+        if: ${{ inputs.system_deps != null }}
+        run: |
+          sudo apt update
+          sudo apt install -y ${{ inputs.system_deps }}
+      - name: upgrade pip
+        run: |
+          pip install --upgrade pip
+      - name: Install Custom Python Requirements
+        if: ${{ inputs.pip_packages != null }}
+        run: |
+          pip install ${{ inputs.pip_packages }}
+      - name: Install repo
+        run: |
+          cd ${{ github.workspace }}/action/package
+          if [ -z ${{ inputs.install_extras }} ]; then
+            pip install .
+          else
+            pip install .[${{ inputs.install_extras }}]
+          fi
+      - name: Get explicit and transitive dependencies
+        run: |
+          pip freeze > requirements-all.txt
+      - name: Check licenses
+        id: license_check_report
+        uses: pilosus/action-pip-license-checker@v2
+        with:
+          requirements: 'requirements-all.txt'
+          fail: 'Copyleft,Other,Error'
+          fails-only: true
+          pre: true
+          verbose: 2
+          exclude: ${{ inputs.packages-exclude }}
+          exclude-license: ${{ inputs.licenses-exclude }}
+      - name: Print report
+        if: ${{ always() }}
+        run: echo "${{ steps.license_check_report.outputs.report }}"

.github/workflows/notify_pr_matrix.yml

@@ -0,0 +1,30 @@
+name: Notify Matrix Chat
+
+# only triggers on pull request closed events
+on:
+  workflow_call:
+    inputs:
+      pr_id:
+        type: number
+        required: true
+      subject:
+        type: string
+        default: ''
+
+jobs:
+  notify_pr_matrix:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get repo
+        run: |
+          echo REPO=$(echo ${{ github.repository}} | cut -d '/' -f 2) >> $GITHUB_ENV
+      - uses: actions/checkout@v4
+      - name: Send message to Matrix bots channel
+        id: matrix-chat-message
+        uses: fadenb/matrix-chat-message@v0.0.6
+        with:
+          homeserver: 'matrix.org'
+          token: ${{ secrets.MATRIX_TOKEN }}
+          channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org'
+          message: |
+            ${{ inputs.subject }} PR merged! (${{ env.REPO }}) [PR](https://github.com/${{ github.repository }}/pull/${{ inputs.pr_id }})

.github/workflows/notify_testing_matrix.yml

@@ -0,0 +1,29 @@
+name: Notify Matrix Chat (Test State)
+
+# only triggers on pull request closed events
+on:
+  workflow_call:
+    inputs:
+      subject:
+        type: string
+        default: 'no subject'
+      release_type:
+        type: string
+        required: true
+      version:
+        type: string
+        description: 'The version of the release'
+        default: 'version unknown'
+
+jobs:
+  notify_pr_matrix:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Send message to Matrix bots channel
+        uses: fadenb/matrix-chat-message@v0.0.6
+        with:
+          homeserver: 'matrix.org'
+          token: ${{ secrets.MATRIX_TOKEN }}
+          channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org'
+          message: "Testing QA phase of a ${{ inputs.release_type }} release (${{ inputs.version }}) started (${{ github.repository }}). Subject to test: ${{ inputs.subject }}"