-
Notifications
You must be signed in to change notification settings - Fork 438
Add Copilot instructions for release PRs #3029
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
Conversation
.github/copilot-instructions.md
Outdated
| - In PRs that match the release-PR patterns above: | ||
| - Review only the following files: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems contradictory to the instruction above not to review these PRs — consider combining these instructions?
- Conditions all must be true, not just any one of them - Make it clearer that no files should be reviewed, except for the two listed ones
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds Copilot instructions for handling release PRs to ensure proper review coverage. It establishes clear guidelines for identifying release PRs and specifies which files should be reviewed during the release process.
Key changes:
- Adds a "Generated code" section header to organize existing content
- Defines criteria for identifying release PRs using title, branch, and target patterns
- Specifies that only
CHANGELOG.mdandpackage.jsonshould be reviewed in release PRs
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:7
- Grammar inconsistency: 'start with two underscores' should be 'that start with two underscores' for consistency with the first usage in the sentence.
GitHub Actions workflows in the `.github/workflows` directory whose filenames start with two underscores (e.g. `__all-platform-bundle.yml`) are automatically generated using the `pr-checks/sync.sh` script from template files in the `pr-checks/checks` directory. Therefore, you do not need to review files in the `.github/workflows` directory that start with two underscores. However, you should review changes to the `pr-checks` directory as well as workflows in the `.github/workflows` directory that do not start with underscores.
I wrote some notes for this and then let Copilot edit them.
Risk assessment
For internal use only. Please select the risk level of this change:
Merge / deployment checklist