ci: Restructure CI

2026-08-05 17:05:57 +08:00 · 2026-06-28 18:22:12 +02:00
parent dd6f83cbc5
commit 4f5c2e22c2
6 changed files with 298 additions and 83 deletions
--- a/.github/workflows/check_and_build.yml
+++ b/.github/workflows/check_and_build.yml
@@ -4,22 +4,17 @@
 name: Build swift

 on:
-  push:
-    branches-ignore:
-      - stable/**
-      - nobuild/**
-  pull_request:
+  merge_group:
+    branches: [main]
+  workflow_dispatch: # manually triggered

 concurrency:
-  group:         ${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

 env:
-  do_vatsim_key: ${{ github.event_name == 'push' }}
-  do_symbols:    ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-  do_doxygen:    ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-  do_static_analysis: ${{ github.event_name == 'push' && github.ref != 'refs/heads/main' }}
-  qt_version:    6.11.1
+  do_symbols:    ${{ github.event_name == 'merge_group' }}
+  qt_version:    &qt_version 6.11.1
  bitrock_version: qt-professional-25.10.1
  bitrock_url:     https://releases.installbuilder.com/installbuilder
  installbuilder_hash_win: f92b1741c78b8f024473f55057b26107c8ed9cc1ca583eb9323d0023a8024e00
@@ -27,13 +22,11 @@ env:
  installbuilder_hash_macos: bffa8b2663c6e9aaaa1ed7cdb41a874d34ff89f22adfab419e172915f8f4ce57
  externals: swift-project/externals
  externals_sha: e1f1743ba159e11b0c065ea8f1ae1a0e91e3bf39
-  use_externals: ${{ secrets.EXTERNALS_PAT != '' }}

 jobs:

  preBuild:
    runs-on: ubuntu-24.04
-    if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository }}
    outputs:
      version: ${{ steps.version.outputs.value }}

@@ -58,57 +51,21 @@ jobs:
          warnIfNotFound: false

  checks:
-    runs-on: ubuntu-22.04
-    needs: preBuild
+    uses: ./.github/workflows/reusable_checks.yml

+  doxygen:
+    uses: ./.github/workflows/reusable_doxygen.yml
+    with:
+      qt_version: *qt_version
+      upload_doxygen: false
+
+  clang-tidy:
+    runs-on: ubuntu-22.04
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          fetch-depth: '0'
-      - name: Install gitlint
-        run: |
-          pip install gitlint==0.19.1
-      - name: Run gitlint
-        run: gitlint --commits d789f61044e63e1a00d8e9f1d4d49c8d9ffc42a9..HEAD
-      - name: Install REUSE
-        run: |
-          pip install reuse==4.0.3
-      - name: Run REUSE lint
-        run: reuse lint
-      - name: Run clang-format
-        run: |
-          scripts/run_clang_format.py
-      - uses: swift-project/setup-cpp@swift
-      - name: Run cppcheck
-        run: |
-          sudo apt-get -y install cppcheck
-          cppcheck --template=gcc --inline-suppr --std=c++17 --enable=style,unusedFunction \
-                   -i src/plugins/weatherdata/gfs/g2clib -DCPPCHECK --force --suppressions-list=cppcheck.supp \
-                   --library=qt.cfg --library=posix.cfg .
-      - name: Install Qt docs
-        if: ${{ env.do_doxygen == 'true' }}
-        uses: jurplel/install-qt-action@v4
-        with:
-          version: ${{ env.qt_version }}
-          no-qt-binaries: true
-          aqtsource: 'git+https://github.com/miurahr/aqtinstall.git@8c3695d4a4e1ceabf6a74dc6c79681656dc6b74b'
-          documentation: true
-          cache: true
-      - name: Run doxygen
-        if: ${{ env.do_doxygen == 'true' }}
-        working-directory: docs
-        run: |
-          sudo apt-get -y install doxygen graphviz
-          doxygen Doxyfile
-        env:
-          DOXY_SRC_ROOT: ..
-          DOXY_TAGFILES: ${{ runner.workspace }}/Qt/Docs/Qt-${{ env.qt_version }}
-      - name: Upload doxygen
-        if: ${{ env.do_doxygen == 'true' }}
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/html/
      - name: Check if clang-tidy analysis is required
        id: check_need_clang_tidy
        run: |
@@ -137,7 +94,7 @@ jobs:
          sudo apt-get -y install dbus-x11 libglu1-mesa-dev libpulse-dev libdbus-1-dev ninja-build
          pip3 install requests conan==2.29.1
      - name: Checkout externals
-        if: ${{ env.use_externals == 'true' && steps.check_need_clang_tidy.outputs.should_run_clang_tidy == 'true' }}
+        if: ${{ steps.check_need_clang_tidy.outputs.should_run_clang_tidy == 'true' }}
        uses: actions/checkout@v6
        env:
          EXTERNALS_PAT: ${{ secrets.EXTERNALS_PAT }}
@@ -168,7 +125,7 @@ jobs:

  buildLinux:
    runs-on: ubuntu-24.04
-    needs: [preBuild, checks]
+    needs: [preBuild, checks, clang-tidy, doxygen]
    env:
      BACKTRACE_SYMBOL_TOKEN: ${{ secrets.BACKTRACE_SYMBOL_TOKEN }}
      BACKTRACE_MINIDUMP_TOKEN: ${{ secrets.BACKTRACE_MINIDUMP_TOKEN }}
@@ -212,7 +169,6 @@ jobs:
          submodules: true
          fetch-depth: 0
      - name: Checkout externals
-        if: ${{ env.use_externals == 'true' }}
        uses: actions/checkout@v6
        env:
          EXTERNALS_PAT: ${{ secrets.EXTERNALS_PAT }}
@@ -237,7 +193,6 @@ jobs:
          eval $(cat session.sh)
          echo "DBUS_SESSION_BUS_ADDRESS=$DBUS_SESSION_BUS_ADDRESS" >>$GITHUB_ENV
      - name: Create Vatsim key file
-        if: ${{ env.do_vatsim_key == 'true' }}
        run: |
          cat >vatsim.json <<EOF
          { "vatsim": { "id": "$VATSIM_ID", "key": "$VATSIM_KEY" } }
@@ -273,7 +228,7 @@ jobs:

  buildWin64:
    runs-on: windows-2025-vs2026
-    needs: [preBuild, checks]
+    needs: [preBuild, checks, clang-tidy, doxygen]
    env:
      BACKTRACE_SYMBOL_TOKEN: ${{ secrets.BACKTRACE_SYMBOL_TOKEN }}
      BACKTRACE_MINIDUMP_TOKEN: ${{ secrets.BACKTRACE_MINIDUMP_TOKEN }}
@@ -328,7 +283,6 @@ jobs:
          submodules: true
          fetch-depth: 0
      - name: Checkout externals
-        if: ${{ env.use_externals == 'true' }}
        uses: actions/checkout@v6
        env:
          EXTERNALS_PAT: ${{ secrets.EXTERNALS_PAT }}
@@ -348,7 +302,6 @@ jobs:
          conan remote login swift "$ARTIFACTORY_USER" --password "$ARTIFACTORY_TOKEN"
          conan install . --output-folder=build_conan --deployer=full_deploy -pr:h=ci/profile_win -pr:b=ci/profile_win
      - name: Create Vatsim key file
-        if: ${{ env.do_vatsim_key == 'true' }}
        run: |
          echo >vatsim.json @"
          { "vatsim": { "id": "$env:VATSIM_ID", "key": "$env:VATSIM_KEY" } }
@@ -386,7 +339,7 @@ jobs:

  buildMacOS:
    runs-on: macos-26
-    needs: [preBuild, checks]
+    needs: [preBuild, checks, clang-tidy, doxygen]
    env:
      BACKTRACE_SYMBOL_TOKEN: ${{ secrets.BACKTRACE_SYMBOL_TOKEN }}
      BACKTRACE_MINIDUMP_TOKEN: ${{ secrets.BACKTRACE_MINIDUMP_TOKEN }}
@@ -435,7 +388,6 @@ jobs:
          submodules: true
          fetch-depth: 0
      - name: Checkout externals
-        if: ${{ env.use_externals == 'true' }}
        uses: actions/checkout@v6
        env:
          EXTERNALS_PAT: ${{ secrets.EXTERNALS_PAT }}
@@ -460,7 +412,6 @@ jobs:
          # https://doc.qt.io/qt-6/macos-issues.html#d-bus-and-macos
          conan install --requires=dbus/1.15.8 --output-folder build_conan_dbus_shared --deployer=full_deploy -o "dbus/*:shared=True" -o "dbus/*:message_bus=True" -pr:h=ci/profile_mac -pr:b=ci/profile_mac_arm
      - name: Create Vatsim key file
-        if: ${{ env.do_vatsim_key == 'true' }}
        run: |
          cat >vatsim.json <<EOF
          { "vatsim": { "id": "$VATSIM_ID", "key": "$VATSIM_KEY" } }
@@ -496,7 +447,7 @@ jobs:

  postBuild:
    runs-on: ubuntu-24.04
-    needs: [preBuild, checks, buildLinux, buildWin64, buildMacOS]
+    needs: [preBuild, checks, clang-tidy, doxygen, buildLinux, buildWin64, buildMacOS]

    steps:
      - name: Download xswiftbus-thin
@@ -520,22 +471,9 @@ jobs:
        with:
          name: xswiftbus-thin-*

-  releaseDocs:
-    runs-on: ubuntu-24.04
-    needs: [preBuild, postBuild]
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-    permissions:
-      id-token: write
-      pages: write
-    environment: github-pages
-
-    steps:
-      - name: Publish doxygen
-        uses: actions/deploy-pages@v5
-
  notify:
    runs-on: ubuntu-24.04
-    needs: [preBuild, checks, buildLinux, buildWin64, buildMacOS, postBuild, releaseDocs]
+    needs: [preBuild, checks, clang-tidy, doxygen, buildLinux, buildWin64, buildMacOS, postBuild]
    if: always()

    steps:
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -0,0 +1,48 @@
+# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Main
+
+on:
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  qt_version:    &qt_version 6.11.1
+
+# This job just publishes the latest Doxygen documentation to GitHub pages.
+# Building and releasing the application is done in the check_and_build (merge queue)
+# and release workflow
+jobs:
+
+  build_doxygen:
+    uses: ./.github/workflows/reusable_doxygen.yml
+    with:
+      upload_doxygen: true
+      qt_version: *qt_version
+
+  publish_doxygen:
+    needs: build_doxygen
+    runs-on: ubuntu-22.04
+    permissions:
+      id-token: write
+      pages: write
+    environment: github-pages
+
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          name: doxygen
+          path: docs/html/
+
+      - name: Upload doxygen
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/html/
+
+      - name: Publish doxygen
+        uses: actions/deploy-pages@v5
--- a/.github/workflows/pr.yml
+++ b/.github/workflows/pr.yml
@@ -0,0 +1,66 @@
+# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Pull request validation
+
+on:
+  pull_request:
+
+concurrency:
+  group: pr-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+env:
+  qt_version:    &qt_version 6.11.1
+
+jobs:
+  checks:
+    uses: ./.github/workflows/reusable_checks.yml
+
+  doxygen:
+    uses: ./.github/workflows/reusable_doxygen.yml
+    with:
+      upload_doxygen: false
+      qt_version: *qt_version
+
+  changelog:
+    runs-on: ubuntu-24.04
+    permissions:
+      pull-requests: read
+      issues: read
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: '0'
+      - name: Check for CHANGELOG or no-changelog label
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          set -e
+
+          BASE_SHA="${{ github.event.pull_request.base.sha }}"
+          HEAD_SHA="${{ github.event.pull_request.head.sha }}"
+
+          echo "Checking changed files..."
+
+          if git diff --name-only "$BASE_SHA" "$HEAD_SHA" | grep -qx "CHANGELOG.md"; then
+            echo "✅ CHANGELOG.md was modified."
+            exit 0
+          fi
+
+          echo "CHANGELOG.md not modified. Checking labels..."
+
+          LABELS=$(gh api \
+            repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels \
+            --jq '.[].name')
+
+          if echo "$LABELS" | grep -qx "no-changelog"; then
+            echo "✅ no-changelog label found."
+            exit 0
+          fi
+
+          echo "::error::This PR must either modify CHANGELOG.md or have the 'no-changelog' label."
+          exit 1
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -0,0 +1,79 @@
+# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Release swift
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-24.04
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Get version
+        id: version
+        run: echo "version=$(python3 -u scripts/utils.py --version)" >> $GITHUB_OUTPUT
+
+      - name: Find merge queue build for this commit
+        id: find_run
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          for i in $(seq 1 10); do
+            RUN_ID=$(gh api \
+              "/repos/${{ github.repository }}/actions/runs" \
+              -f head_sha=${{ github.sha }} \
+              -f workflow_file_name=check_and_build.yml \
+              -f status=success \
+              --jq '.workflow_runs[0].id // empty')
+            if [ -n "$RUN_ID" ]; then
+              echo "run_id=$RUN_ID" >> $GITHUB_OUTPUT
+              exit 0
+            fi
+            echo "Attempt $i: Artifact not found yet, retrying in 30s..."
+            sleep 30
+          done
+          echo "::error::No successful build found for SHA ${{ github.sha }}"
+          exit 1
+
+      - name: Download artifacts
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api \
+            "/repos/${{ github.repository }}/actions/runs/${{ steps.find_run.outputs.run_id }}/artifacts" \
+            --jq '.artifacts[] | .name + " " + .archive_download_url' \
+          | while read name url; do
+              gh api "$url" > "${name}.zip"
+              unzip -o "${name}.zip" -d "${name}"
+            done
+      - name: Flatten directories
+        run: |
+          mv swiftinstaller-*/* .
+          mv xswiftbus-*/* .
+          mkdir swiftsymbols
+          mv swiftsymbols-*/* swiftsymbols
+      - name: Create release
+        uses: swift-project/github-release@2.0-connreset-retry
+        id: create
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: v${{ steps.version.outputs.version }}
+          commitish: ${{ github.sha }}
+          body: Version ${{ steps.version.outputs.version }}
+          draft: true
+          prerelease: true
+          gzip: folders
+          files: >
+            swiftinstaller-linux-64-${{ steps.version.outputs.version }}.run
+            swiftinstaller-windows-64-${{ steps.version.outputs.version }}.exe
+            swiftinstaller-macos-64-${{ steps.version.outputs.version }}.dmg
+            xswiftbus-fat-allos-${{ steps.version.outputs.version }}.zip
+            swiftsymbols-allos-${{ steps.version.outputs.version }}:swiftsymbols
--- a/.github/workflows/reusable_checks.yml
+++ b/.github/workflows/reusable_checks.yml
@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Checks
+
+on:
+  workflow_call:
+
+jobs:
+  checks:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install gitlint
+        run: pip install gitlint==0.19.1
+
+      - name: Run gitlint
+        run: gitlint --commits d789f61044e63e1a00d8e9f1d4d49c8d9ffc42a9..HEAD
+
+      - name: Install REUSE
+        run: pip install reuse==4.0.3
+
+      - name: Run REUSE lint
+        run: reuse lint
+
+      - name: Run clang-format
+        run: scripts/run_clang_format.py
+      - uses: swift-project/setup-cpp@df5d21a5dd12577254a9748fddf23e075a4a7ddc
+      - name: Run cppcheck
+        run: |
+          sudo apt-get -y install cppcheck
+          cppcheck --template=gcc --inline-suppr --std=c++17 \
+                   --enable=style,unusedFunction \
+                   -i src/plugins/weatherdata/gfs/g2clib \
+                   -DCPPCHECK --force \
+                   --suppressions-list=cppcheck.supp \
+                   --library=qt.cfg --library=posix.cfg .
--- a/.github/workflows/reusable_doxygen.yml
+++ b/.github/workflows/reusable_doxygen.yml
@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Doxygen
+
+on:
+  workflow_call:
+    inputs:
+      upload_doxygen:
+        type: boolean
+        default: false
+      qt_version:
+        type: string
+        required: true
+
+jobs:
+  build_doxygen:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Install Qt docs
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: ${{ inputs.qt_version }}
+          no-qt-binaries: true
+          documentation: true
+          cache: true
+      - name: Run doxygen
+        working-directory: docs
+        run: |
+          sudo apt-get -y install doxygen graphviz
+          doxygen Doxyfile
+        env:
+          DOXY_SRC_ROOT: ..
+          DOXY_TAGFILES: ${{ runner.workspace }}/Qt/Docs/Qt-${{ inputs.qt_version }}
+
+      - uses: actions/upload-artifact@v4
+        if: inputs.upload_doxygen
+        with:
+          name: doxygen
+          path: docs/html/
+          retention-days: 1