[mod] refactor integration.yml (#4763 )

Style changes, cleanup and improved integration with CI by leveraging the use of shared cache between all workflows.
[mod] new l10n.yml workflow (#4734 )
2025-05-10 13:59:31 +02:00 · 2025-05-10 13:08:20 +02:00 · 2025-05-10 07:41:42 +02:00
4 changed files with 211 additions and 129 deletions
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@ -4,11 +4,10 @@ name: Documentation
 # yamllint disable-line rule:truthy
 on:
  workflow_dispatch:
-  workflow_run:
-    workflows:
-      - Integration
-    types:
-      - completed
+  push:
+    branches:
+      - master
+  pull_request:
    branches:
      - master

@ -24,7 +23,6 @@ env:

 jobs:
  release:
-    if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
    name: Release
    runs-on: ubuntu-24.04-arm
    permissions:
@ -56,7 +54,8 @@ jobs:
      - name: Build documentation
        run: make V=1 docs.clean docs.html

-      - name: Release
+      - if: github.ref_name == 'master'
+        name: Release
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: "dist/docs"
--- a/.github/workflows/integration.yml
+++ b/.github/workflows/integration.yml
@ -1,100 +1,106 @@
+---
 name: Integration

-on:  # yamllint disable-line rule:truthy
+# yamllint disable-line rule:truthy
+on:
  push:
-    branches: ["master"]
+    branches:
+      - master
  pull_request:
-    branches: ["master"]
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: false

 permissions:
  contents: read

+env:
+  PYTHON_VERSION: "3.13"
+
 jobs:
-  python:
+  test:
    name: Python ${{ matrix.python-version }}
    runs-on: ubuntu-24.04
    strategy:
      matrix:
-        os: [ubuntu-24.04]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install Ubuntu packages
-        run: |
-          sudo ./utils/searxng.sh install packages
-      - name: Set up Python
+      - name: Setup Python
        uses: actions/setup-python@v5
        with:
-          python-version: ${{ matrix.python-version }}
-          architecture: 'x64'
+          python-version: "${{ matrix.python-version }}"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: "false"
+
+      - name: Setup cache Python
+        uses: actions/cache@v4
+        with:
+          key: "python-${{ matrix.python-version }}-${{ runner.arch }}-${{ hashFiles('./requirements*.txt') }}"
+          restore-keys: "python-${{ matrix.python-version }}-${{ runner.arch }}-"
+          path: "./local/"
+
+      - name: Setup venv
+        run: make V=1 install
+
      - name: Run tests
        run: make V=1 ci.test

-  themes:
-    name: Themes
-    runs-on: ubuntu-24.04
+  theme:
+    name: Theme
+    runs-on: ubuntu-24.04-arm
    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install Ubuntu packages
-        run: sudo ./utils/searxng.sh install buildhost
-      - name: Set up Python
+      - name: Setup Python
        uses: actions/setup-python@v5
        with:
-          python-version: '3.12'
-          architecture: 'x64'
-      - name: Build themes
-        run: make themes.all
+          python-version: "${{ env.PYTHON_VERSION }}"

-  babel:
-    name: Update translations branch
-    runs-on: ubuntu-24.04
-    if: ${{ github.repository_owner == 'searxng' && github.ref == 'refs/heads/master' }}
-    needs:
-      - python
-      - themes
-    permissions:
-      contents: write  # for make V=1 weblate.push.translations
-    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
-          fetch-depth: '0'
-          token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
-      - name: Set up Python
-        uses: actions/setup-python@v5
+          persist-credentials: "false"
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
        with:
-          python-version: '3.12'
-          architecture: 'x64'
-      - name: Cache Python dependencies
-        id: cache-python
+          node-version-file: "./.nvmrc"
+
+      - name: Setup cache Node.js
        uses: actions/cache@v4
        with:
-          path: |
-            ./local
-            ./.nvm
-            ./node_modules
-          key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
-      - name: weblate & git setup
-        env:
-          WEBLATE_CONFIG: ${{ secrets.WEBLATE_CONFIG }}
-        run: |
-          mkdir -p ~/.config
-          echo "${WEBLATE_CONFIG}" > ~/.config/weblate
-          git config --global user.email "searxng-bot@users.noreply.github.com"
-          git config --global user.name "searxng-bot"
-      - name: Update transations
-        id: update
-        run: |
-          make V=1 weblate.push.translations
+          key: "nodejs-${{ runner.arch }}-${{ hashFiles('./.nvmrc', './package.json') }}"
+          path: "./client/simple/node_modules/"
+
+      - name: Setup cache Python
+        uses: actions/cache@v4
+        with:
+          key: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-${{ hashFiles('./requirements*.txt') }}"
+          restore-keys: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-"
+          path: "./local/"
+
+      - name: Setup venv
+        run: make V=1 install
+
+      - name: Build
+        run: make themes.all

  dockers:
    name: Docker
    if: github.ref == 'refs/heads/master'
    needs:
-      - python
-      - themes
+      - test
+      - theme
    env:
      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
    runs-on: ubuntu-24.04
--- a/.github/workflows/l10n.yml
+++ b/.github/workflows/l10n.yml
@ -0,0 +1,136 @@
+---
+name: Translation
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+  workflow_run:
+    workflows:
+      - Integration
+    types:
+      - completed
+    branches:
+      - master
+  schedule:
+    - cron: "05 07 * * 5"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+env:
+  PYTHON_VERSION: "3.13"
+
+jobs:
+  update:
+    if: github.repository_owner == 'searxng' && github.event.workflow_run.conclusion == 'success'
+    name: Update
+    runs-on: ubuntu-24.04-arm
+    permissions:
+      # For "make V=1 weblate.push.translations"
+      contents: write
+
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ env.PYTHON_VERSION }}"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          token: "${{ secrets.WEBLATE_GITHUB_TOKEN }}"
+          fetch-depth: "0"
+
+      - name: Setup cache Python
+        uses: actions/cache@v4
+        with:
+          key: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-${{ hashFiles('./requirements*.txt') }}"
+          restore-keys: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-"
+          path: "./local/"
+
+      - name: Setup venv
+        run: make V=1 install
+
+      - name: Setup Weblate
+        run: |
+          mkdir -p ~/.config
+          echo "${{ secrets.WEBLATE_CONFIG }}" > ~/.config/weblate
+
+      - name: Setup Git
+        run: |
+          git config --global user.email "searxng-bot@users.noreply.github.com"
+          git config --global user.name "searxng-bot"
+
+      - name: Update translations
+        run: make V=1 weblate.push.translations
+
+  pr:
+    if: |
+      github.repository_owner == 'searxng'
+      && (github.event_name == 'workflow_dispatch' || github.event_name == 'schedule')
+    name: Pull Request
+    runs-on: ubuntu-24.04-arm
+    permissions:
+      # For "make V=1 weblate.translations.commit"
+      contents: write
+      # For action "peter-evans/create-pull-request"
+      pull-requests: write
+
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ env.PYTHON_VERSION }}"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          token: "${{ secrets.WEBLATE_GITHUB_TOKEN }}"
+          fetch-depth: "0"
+
+      - name: Setup cache Python
+        uses: actions/cache@v4
+        with:
+          key: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-${{ hashFiles('./requirements*.txt') }}"
+          restore-keys: "python-${{ env.PYTHON_VERSION }}-${{ runner.arch }}-"
+          path: "./local/"
+
+      - name: Setup venv
+        run: make V=1 install
+
+      - name: Setup Weblate
+        run: |
+          mkdir -p ~/.config
+          echo "${{ secrets.WEBLATE_CONFIG }}" > ~/.config/weblate
+
+      - name: Setup Git
+        run: |
+          git config --global user.email "searxng-bot@users.noreply.github.com"
+          git config --global user.name "searxng-bot"
+
+      - name: Merge and push translation updates
+        run: make V=1 weblate.translations.commit
+
+      - name: Create PR
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          author: "${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>"
+          committer: "searxng-bot <searxng-bot@users.noreply.github.com>"
+          title: "[l10n] update translations from Weblate"
+          commit-message: "[l10n] update translations from Weblate"
+          branch: "translations_update"
+          delete-branch: "true"
+          draft: "false"
+          signoff: "false"
+          labels: |
+            translation
+
+      - name: Display information
+        run: |
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
--- a/.github/workflows/translations-update.yml
+++ b/.github/workflows/translations-update.yml
@ -1,59 +0,0 @@
-name: "Update translations"
-on:  # yamllint disable-line rule:truthy
-  schedule:
-    - cron: "05 07 * * 5"
-  workflow_dispatch:
-
-jobs:
-  babel:
-    name: "create PR for additions from weblate"
-    runs-on: ubuntu-24.04
-    if: ${{ github.repository_owner == 'searxng' && github.ref == 'refs/heads/master' }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: '0'
-          token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-          architecture: 'x64'
-      - name: Cache Python dependencies
-        id: cache-python
-        uses: actions/cache@v4
-        with:
-          path: |
-            ./local
-            ./.nvm
-            ./node_modules
-          key: python-ubuntu-24.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
-      - name: weblate & git setup
-        env:
-          WEBLATE_CONFIG: ${{ secrets.WEBLATE_CONFIG }}
-        run: |
-          mkdir -p ~/.config
-          echo "${WEBLATE_CONFIG}" > ~/.config/weblate
-          git config --global user.email "searxng-bot@users.noreply.github.com"
-          git config --global user.name "searxng-bot"
-      - name: Merge and push transation updates
-        run: |
-          make V=1 weblate.translations.commit
-      - name: Create Pull Request
-        id: cpr
-        uses: peter-evans/create-pull-request@v3
-        with:
-          token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
-          commit-message: '[l10n] update translations from Weblate'
-          committer: searxng-bot <searxng-bot@users.noreply.github.com>
-          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
-          signoff: false
-          branch: translations_update
-          delete-branch: true
-          draft: false
-          title: '[l10n] update translations from Weblate'
-          body: |
-            update translations from Weblate
-          labels: |
-            translation