🧪 Introduce a gate/check GHA job#635
Conversation
.github/workflows/tests.yml
Outdated
| python-version: "3.8" | ||
| sphinx: ">=4,<5" | ||
|
|
||
| continue-on-error: >- |
There was a problem hiding this comment.
@chrisjsewell this is here to match the currently set up branch protection.
There was a problem hiding this comment.
I removed this as I think its not necessary to ignore any
| run: echo "test" | myst-docutils-html | ||
|
|
||
| # https://github.com/marketplace/actions/alls-green#why | ||
| check: # This job does nothing and is only used for the branch protection |
There was a problem hiding this comment.
This is what should eventually replace all the individual branch protection checks that belong to this workflow.
|
|
||
| publish: | ||
|
|
||
| name: Publish myst-parser to PyPi |
There was a problem hiding this comment.
An unrelated comment/suggestion for the future: this could use an environment setting and secrets could be scoped to it instead of being accessible globally.
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, conda, coveragepy, Open edX, Towncrier some of the Ansible repositories, pip-tools, all of the jaraco's projects (like `setuptools`, `importlib_metadata`), some of hynek's projects (like `attrs`, `structlog`), some PyCQA, PyCA, PyPA 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 MyST 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.
d380cb5 to
d7f0748
Compare
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #635 +/- ##
=======================================
Coverage 90.00% 90.00%
=======================================
Files 23 23
Lines 2970 2970
=======================================
Hits 2673 2673
Misses 297 297
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Congrats on your first merged pull request in this project! 🎉 |
|
Cheers! |
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, conda, coveragepy, Open edX, Towncrier some of the Ansible repositories, pip-tools, all of the jaraco's projects (like
setuptools,importlib_metadata), some of hynek's projects (likeattrs,structlog), some PyCQA, PyCA, PyPA 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 MyST 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.