Clarify instructions for updating PR checks to avoid emphasis on main
#3086
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
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the update-required-checks.sh script to clarify when the script should be run against a PR branch rather than the main branch. The changes reduce emphasis on running the script against main and provide clearer guidance for scenarios where PR branches should be used instead.
Key changes:
- Clarifies that the script should be run from a PR branch when that PR adds/removes checks
- Restructures documentation to better explain the script's flexibility with commit SHA arguments
- Removes outdated comment that emphasized
mainas the typical usage
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Updated documentation to clarify script usage patterns and provide better guidance on when to use PR branches vs main |
| .github/workflows/script/update-required-checks.sh | Removed comment that emphasized main branch as typical usage |
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.
Since changes are typically introduced by PRs and all required PR checks need to pass before a PR can be merged, the
update-required-checks.shscript likely needs to be run from the HEAD of a PR branch if the PR removes any checks or changes their names. This PR updates the relevant documentation so that there's less emphasis on running the script againstmain.Risk assessment
For internal use only. Please select the risk level of this change:
Merge / deployment checklist