chore: add QA checks to Test workflow
#219
Merged
Conversation
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 change adds a new `QA` job to the existing `Test` workflow. It is done in a way that the `Test rollup` job can continue to be an enforced status check, but with the addition of this job. A new optional `tox` test environment named `qa` was added and is called by the `QA` job. The environment can also be called by users locally. It relies on simply running `pre-commit` on the existing hooks defined in the repository: * trim trailing whitespace * fix end of files * check yaml * check for added large files * `black` * `pyupgrade` * analyze lockfile with `phylum-ci` The `pre-commit` package was added as a dependency in the `qa` group and can therefore be kept under configuration control and used by `poetry`. Documentation was updated to make all the new usage patterns explicit. Additional QA checks and `pre-commit` hooks will be added separatetely.
Phylum OSS Supply Chain Risk Analysis - SUCCESSThe Phylum risk analysis is complete and did not identify any issues. |
kylewillmon
previously approved these changes
Apr 4, 2023
When no CLI version is specified and no CLI is installed, the version is reported as `latest` instead of the current latest version in full "vMajor.Minor.Bugfix" format.
We need to skip the `phylum-ci` pre-commit hook since: * The current GitHub integration expects to *only* run in a PR context * The `Test` workflow also includes `workflow_dispatch` and `push` * The integration will fail even if a `GITHUB_TOKEN` is provided * The `phylum-ci` action will already be run for pull request triggers It is possible this restriction can be lifted in the future if the GitHub integration is updated to account for additional execution contexts beyond pull requests.
|
FYI...I tried to enable auto-merge on this PR and accidentally merged it outright instead. @kylewillmon took a look at the PR again (since his last review and after this accidental merge) and confirmed that it looked good to him. |
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.
This change adds a new
QAjob to the existingTestworkflow. It is done in a way that theTest rollupjob can continue to be an enforced status check, but with the addition of this job. A new optionaltoxtest environment namedqawas added and is called by theQAjob. The environment can also be called by users locally. It relies on simply runningpre-commiton the existing hooks defined in the repository:blackpyupgradephylum-ciThe
phylum-cipre-commit hook is skipped in theQAjob since:Testworkflow also includesworkflow_dispatchandpushGITHUB_TOKENis providedphylum-ciaction will already be run for pull request triggersIt is possible this restriction can be lifted in the future if the
GitHub integration is updated to account for additional execution
contexts beyond pull requests.
The
pre-commitpackage was added as a dependency in theqagroup and can therefore be kept under configuration control and used bypoetry. Documentation was updated to make all the new usage patterns explicit.Additional QA checks and
pre-commithooks will be added separately.Additional changes made include:
latestCloses #14
Checklist
closes #<issueNum>in description above)?