Various CI and doc refactors #3220
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: diff-shades | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - src/** | |
| - pyproject.toml | |
| - scripts/diff_shades_gha_helper.py | |
| - .github/workflows/diff_shades.yml | |
| pull_request: | |
| paths: | |
| - src/** | |
| - pyproject.toml | |
| - scripts/diff_shades_gha_helper.py | |
| - .github/workflows/diff_shades.yml | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| HATCH_BUILD_HOOKS_ENABLE: "1" | |
| # Clang is less picky with the C code it's given than gcc (and may generate faster | |
| # binaries too). | |
| CC: clang-18 | |
| permissions: {} | |
| jobs: | |
| configure: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| matrix: ${{ steps.set-config.outputs.matrix }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: "3.13" | |
| pip-version: "25.3" | |
| pip-install: --group diff-shades --group diff-shades-comment | |
| - name: Calculate run configuration & metadata | |
| id: set-config | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: python scripts/diff_shades_gha_helper.py config | |
| analysis-base: | |
| name: analysis / base / ${{ matrix.mode }} | |
| needs: configure | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: ${{ fromJson(needs.configure.outputs.matrix) }} | |
| steps: | |
| - name: Checkout this repository (full clone) | |
| uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| with: | |
| # The baseline revision could be rather old so a full clone is ideal. | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: "3.13" | |
| pip-version: "25.3" | |
| pip-install: --group diff-shades | |
| - name: Configure git | |
| run: | | |
| git config user.name "diff-shades-gha" | |
| git config user.email "[email protected]" | |
| - name: Attempt to use cached baseline analysis | |
| id: baseline-cache | |
| uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 | |
| with: | |
| path: ${{ matrix.baseline-analysis }} | |
| key: ${{ matrix.baseline-cache-key }} | |
| - name: Build and install baseline revision | |
| if: steps.baseline-cache.outputs.cache-hit != 'true' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: | | |
| ${{ matrix.baseline-setup-cmd }} | |
| python -m pip install . | |
| - name: Analyze baseline revision | |
| if: steps.baseline-cache.outputs.cache-hit != 'true' | |
| run: | |
| diff-shades analyze ${{ matrix.baseline-analysis }} --work-dir projects-cache/ | |
| --force-${{ matrix.style }}-style -v | |
| - name: Upload baseline analysis | |
| uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | |
| with: | |
| name: ${{ matrix.baseline-analysis }} | |
| path: ${{ matrix.baseline-analysis }} | |
| analysis-target: | |
| name: analysis / target / ${{ matrix.mode }} | |
| needs: configure | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: ${{ fromJson(needs.configure.outputs.matrix) }} | |
| steps: | |
| - name: Checkout this repository (full clone) | |
| uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| with: | |
| # The baseline revision could be rather old so a full clone is ideal. | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: "3.13" | |
| pip-version: "25.3" | |
| pip-install: --group diff-shades | |
| - name: Configure git | |
| run: | | |
| git config user.name "diff-shades-gha" | |
| git config user.email "[email protected]" | |
| - name: Build and install target revision | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: | | |
| ${{ matrix.target-setup-cmd }} | |
| python -m pip install . | |
| # Pull it from previous runs - we're NOT trying to get it from this run | |
| # (but it wouldn't cause problems if we theoretically did) | |
| - name: Attempt to find baseline analysis | |
| id: baseline-cache | |
| uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 | |
| with: | |
| path: ${{ matrix.baseline-analysis }} | |
| key: ${{ matrix.baseline-cache-key }} | |
| - name: Analyze target revision (with repeated projects) | |
| if: steps.baseline-cache.outputs.cache-hit == 'true' | |
| run: | | |
| diff-shades analyze ${{ matrix.target-analysis }} --work-dir projects-cache/ \ | |
| --force-${{ matrix.style }}-style -v \ | |
| --repeat-projects-from ${{ matrix.baseline-analysis }} | |
| - name: Analyze target revision (without repeated projects) | |
| if: steps.baseline-cache.outputs.cache-hit != 'true' | |
| run: | |
| diff-shades analyze ${{ matrix.target-analysis }} --work-dir projects-cache/ | |
| --force-${{ matrix.style }}-style -v | |
| - name: Upload target analysis | |
| uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | |
| with: | |
| name: ${{ matrix.target-analysis }} | |
| path: ${{ matrix.target-analysis }} | |
| - name: Check for failed files for target revision | |
| run: diff-shades show-failed --check --show-log ${{ matrix.target-analysis }} | |
| compare: | |
| name: compare / ${{ matrix.mode }} | |
| needs: ["configure", "analysis-base", "analysis-target"] | |
| if: ${{ !cancelled() }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: ${{ fromJson(needs.configure.outputs.matrix) }} | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | |
| with: | |
| merge-multiple: true | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: "3.13" | |
| pip-version: "25.3" | |
| pip-install: --group diff-shades --group diff-shades-comment | |
| - name: Generate HTML diff report | |
| run: | | |
| diff-shades --dump-html diff.html \ | |
| compare --diff ${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }} | |
| - name: Upload diff report | |
| uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | |
| with: | |
| name: ${{ matrix.style }}-diff.html | |
| path: diff.html | |
| - name: Generate summary file (PR only) | |
| if: github.event_name == 'pull_request' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: | | |
| python scripts/diff_shades_gha_helper.py comment-body \ | |
| ${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }} \ | |
| ${{ matrix.style }} ${{ matrix.mode }} | |
| - name: Upload summary file (PR only) | |
| if: github.event_name == 'pull_request' | |
| uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | |
| with: | |
| name: .${{ matrix.style }}.pr-comment.md | |
| path: .${{ matrix.style }}.pr-comment.md | |
| include-hidden-files: true | |
| - name: Verify zero changes (PR only) | |
| if: matrix.mode == 'assert-no-changes' | |
| run: | | |
| diff-shades compare --check \ | |
| ${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }} || \ | |
| (echo "Please verify you didn't change the stable code style unintentionally!" \ | |
| && exit 1) | |
| comment: | |
| needs: ["configure", "compare"] | |
| if: ${{ !cancelled() && github.event_name == 'pull_request' }} | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: write | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | |
| with: | |
| merge-multiple: true | |
| pattern: ".*.pr-comment.md" | |
| - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 | |
| with: | |
| python-version: "3.13" | |
| pip-version: "25.3" | |
| pip-install: --group diff-shades-comment | |
| - name: Get details from initial workflow run | |
| id: metadata | |
| run: python scripts/diff_shades_gha_helper.py comment-details "$styles" | |
| env: | |
| styles: ${{ join(fromJson(needs.configure.outputs.matrix).*.style, ',') }} | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Try to find pre-existing PR comment | |
| id: find-comment | |
| uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| comment-author: "github-actions[bot]" | |
| body-includes: "diff-shades" | |
| - name: Create or update PR comment | |
| uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 | |
| with: | |
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: ${{ steps.metadata.outputs.comment-body }} | |
| edit-mode: replace |