fix: docs don't trigger required checks #5
Workflow file for this run
This file contains 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
| # This workflow is triggered by changes on the documentation. Normally, if only documentation is modified, the required Forest checks are not triggered which makes it impossible to merge the PR. See <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks#handling-skipped-but-required-checks>. The workaround is to provide no-op jobs that are triggered by the same events as the docs-check job. This way, the "required checks" are passing and the PR can be merged. | |
| name: Docs Required Override | |
| concurrency: | |
| group: '${{ github.workflow }}-${{ github.ref }}' | |
| cancel-in-progress: '${{ github.ref != ''refs/heads/main'' }}' | |
| on: | |
| workflow_dispatch: | |
| merge_group: | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - '**.md' | |
| - 'docs/**' | |
| - '.github/workflows/docs-check.yml' | |
| - '.github/workflows/docs-required-override.yml' | |
| # - '!**' # ignore all other paths | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - '**.md' | |
| - 'docs/**' | |
| - '.github/workflows/docs-check.yml' | |
| - '.github/workflows/docs-required-override.yml' | |
| # - '!**' # ignore all other paths | |
| jobs: | |
| # We need this because merge groups dont support path filters | |
| # https://github.com/community/community/discussions/45899 | |
| changes: | |
| name: Determine if we need to run the workflow | |
| runs-on: ubuntu-latest | |
| outputs: | |
| changesFound: ${{ steps.filter.outputs.changesFound }} | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v4 | |
| - uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| changesFound: | |
| - 'docs/**' | |
| - '**.md' | |
| - '.github/workflows/docs-check.yml' | |
| - '.github/workflows/docs-required-override.yml' | |
| - '!**' | |
| test: | |
| name: Calibnet check | |
| runs-on: ubuntu-latest | |
| needs: changes | |
| if: ${{ needs.changes.outputs.changesFound == 'true' }} | |
| steps: | |
| - run: echo "No-op job to trigger the required checks" |