Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🧪 Introduce a gate/check GHA job #635

Merged
merged 3 commits into from
Jun 5, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ jobs:
python-version: "3.8"
sphinx: ">=5,<6"

continue-on-error: >-
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chrisjsewell this is here to match the currently set up branch protection.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this as I think its not necessary to ignore any

${{
(matrix.python-version == '3.8' && matrix.sphinx == '>=5,<6')
&& true || false
}}

chrisjsewell marked this conversation as resolved.
Show resolved Hide resolved
runs-on: ${{ matrix.os }}

steps:
Expand Down Expand Up @@ -101,10 +107,29 @@ jobs:
- name: Run docutils CLI
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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what should eventually replace all the individual branch protection checks that belong to this workflow.


if: always()

needs:
- pre-commit
- tests
- check-myst-docutils

runs-on: ubuntu-latest

steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}

publish:

name: Publish myst-parser to PyPi
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

needs: [pre-commit, tests, check-myst-docutils]
needs:
- check
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
runs-on: ubuntu-latest
steps:
Expand Down