Introduce a gate/check GHA job #97533
Conversation
This adds a GHA job that reliably determines if all the required dependencies have succeeded or not. It also allows to reduce the list of required branch protection CI statuses to just one — `check`. This reduces the maintenance burden by a lot and have been battle-tested across a small bunch of projects in its action form and in-house implementations of other people. This action is now in use in aiohttp (and other aio-libs projects), CherryPy, some of the Ansible repositories, all of the jaraco's projects (like `setuptools`, `importlib_metadata`), some PyCQA, PyCA and pytest projects, a few AWS Labs projects. Admittedly, I maintain a few of these but it seems to address some of the pain folks have: jaraco/skeleton#55 (comment). I figured, this might be useful for CPython too, which is why I'm submitting this patch. The story behind this is explained in more detail at https://github.com/marketplace/actions/alls-green#why.
| @@ -116,6 +116,7 @@ jobs: | |||
| runs-on: windows-latest | |||
| needs: check_source | |||
| if: needs.check_source.outputs.run_tests == 'true' | |||
| continue-on-error: true | |||
There was a problem hiding this comment.
By default, all the jobs listed in the check job's needs section are required to succeed in terms of branch protection. This setting emulates having the job non-required (in combination with the check job below being the only thing required in branch protection).
| @@ -317,3 +320,44 @@ jobs: | |||
| run: make pythoninfo | |||
| - name: Tests | |||
| run: xvfb-run make buildbottest TESTOPTS="-j4 -uall,-cpu" | |||
|
|
|||
| check: # This job does nothing and is only used for the branch protection | |||
| if: always() | |||
There was a problem hiding this comment.
This is necessary because otherwise it'll get a skipped status in some cases and the branch protection sees that as skipped == success which is undesired.
| - name: Decide whether the needed jobs succeeded or failed | ||
| uses: re-actors/alls-green@198badcb65a1a44528f27d5da555c4be9f12eac6 | ||
| with: | ||
| allowed-skips: >- |
There was a problem hiding this comment.
This setting tells the action that if the listed jobs (comma-separated) got skipped, that's okay. But the jobs are allowed to be skipped based on the same condition they've got set. If the first job requests test runs, this list will compute as empty and none of the jobs will be allowed to be skipped (meaning that skips would turn into failures).
This adds a GHA job that reliably determines if all the required dependencies have succeeded or not.
It also allows to reduce the list of required branch protection CI statuses to just one —
check. This reduces the maintenance burden by a lot and have been battle-tested across a small bunch of projects in its action form and in-house implementations of other people.This action is now in use in aiohttp (and other aio-libs projects), CherryPy, some of the Ansible repositories, all of the jaraco's projects (like
setuptools,importlib_metadata), some PyCQA, PyCA and pytest projects, a few AWS Labs projects. Admittedly, I maintain a few of these but it seems to address some of the pain folks have: jaraco/skeleton#55 (comment).I saw a few attempts to reduce the maintenance burden for GHA and figured
this might be useful for CPython too, which is why I'm submitting this patch.
Looking forward to hearing what you think!
The story behind this is explained in more detail at https://github.com/marketplace/actions/alls-green#why.