Skip to content

Commit 9065906

Browse files
committed
Add Copilot instructions for release PRs
1 parent cc722e4 commit 9065906

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/copilot-instructions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# CodeQL Action - Copilot Instructions
22

3+
## Generated code
4+
35
The CodeQL Action is written in TypeScript and compiled to JavaScript. Both the TypeScript sources and the **generated** JavaScript code are contained in this repository. The TypeScript sources are contained in the `src` directory and the JavaScript code is contained in the `lib` directory. A GitHub Actions workflow checks that the JavaScript code in `lib` is up-to-date. Therefore, you should not review any changes to the contents of the `lib` folder and it is expected that the JavaScript code in `lib` closely mirrors the TypeScript code it is generated from.
46

57
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 starts 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.
8+
9+
## Release process
10+
11+
- Do not review PRs that match any of the following release-PR patterns:
12+
- PR title starts with the exact prefix: `Merge main into releases/v`
13+
- Equivalent regex: `^Merge main into releases\/v`
14+
- OR head (source) branch matches the update-branch pattern:
15+
- Regex: `^update-v[0-9]+(?:\.[0-9]+)*(?:-[a-f0-9]+)?` (e.g. `update-v3.29.9-cc722e476`)
16+
- OR base (target) branch matches a release branch:
17+
- Regex: `^releases\/v` (e.g. `releases/v3`)
18+
19+
- In PRs that match the release-PR patterns above:
20+
- Review only the following files:
21+
- `CHANGELOG.md`
22+
- `package.json`
23+
- Do not review other files in those PRs (these are considered mechanically generated updates).
24+
25+
- If a PR matches the release-PR patterns but includes changes outside the two files above, do not attempt a full review of the generated changes — treat non-`CHANGELOG.md`/`package.json` edits as not requiring review.

0 commit comments

Comments
 (0)