Doc / workflow changes to trigger PR workflow#70
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation and GitHub Actions to better support development workflows, including running pre-commit and tests on pull requests.
Changes:
- Add a “Development” section to the README with contributor/pre-commit guidance.
- Update pre-commit hook revisions.
- Rework the pull-request CI workflow to run pre-commit and adjust the test matrix / action versions.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds contributor/development guidance, including pre-commit usage and PR behavior. |
| .pre-commit-config.yaml | Updates the pinned version of pre-commit-hooks. |
| .github/workflows/pull-request-check.yml | Renames/retools the PR workflow and adds a pre-commit run step. |
Comments suppressed due to low confidence (3)
.github/workflows/pull-request-check.yml:17
- The
stepslist is mis-indented:- uses: ...is aligned withsteps:instead of being nested under it. This makes the workflow YAML invalid and the job won’t run. Indent the step entries understeps:(e.g.,steps:followed by- ...).
.github/workflows/pull-request-check.yml:6 - This workflow is configured to run only for PRs targeting
master, but the repository context/diff indicates the default branch ismain(the previous config targetedmain). As written, the workflow won’t trigger for PRs intomain. Update the target branch (or remove the branch filter if you want it for all PRs).
This issue also appears in the following locations of the same file:
- line 14
- line 30
.github/workflows/pull-request-check.yml:34
pre-commit run --from-ref origin/master --to-ref HEADhard-codes the base branch name. This will fail when the PR base branch isn’tmaster(e.g.,main) and is also brittle for repos that rename default branches. Use the PR’s actual base ref/SHA (e.g.,${{ github.base_ref }}/${{ github.event.pull_request.base.sha }}) instead of a fixedorigin/master.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.