Update GitHub Actions #864
Merged
Conversation
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
fa9r
force-pushed
the
misc/separate-docstring-ci-checks-from-lint
branch
from
973eca6 to
360ee2e
Compare
schustmi
approved these changes
Aug 29, 2022
strickvl
approved these changes
Aug 29, 2022
CONTRIBUTING.md
Outdated
Comment on lines
142
to
145
| poetry run bash scripts/format.sh | ||
| poetry run bash scripts/lint.sh | ||
| poetry run bash scripts/docstring.sh | ||
| poetry run bash scripts/check-spelling.sh |
Contributor
There was a problem hiding this comment.
wonder whether this a lot for people to do & if we should consider consolidating some of these into a single command for the sake of external contributors, albeit keeping the individual scripts / commands for ourselves...)
Contributor
Author
There was a problem hiding this comment.
Great idea! I added a run-ci-checks.sh script that combines linting, docstring checks, and spell checks and adjusted the contributing guide accordingly.
…g, and docstring checking.
fa9r
changed the title
stefannica
pushed a commit
that referenced
this pull request
Sep 14, 2022
* Split docstring checking into a separate GitHub action that only runs once. * Adjust precommit and contributer guide. * Always pass markdown link checker and make output more concise. * Add script for external contributors that runs linting, spell checking, and docstring checking.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe changes
I made two changes to our GitHub Actions:
Pre-requisites
Please ensure you have done the following:
Types of changes