Skip to content

Commit 7fbadd1

Browse files
committed
Merge branch 'main' into mbg/ts/remaining-scripts
2 parents 7e36708 + eb94de7 commit 7fbadd1

159 files changed

Lines changed: 56949 additions & 25017 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/actions/prepare-mergeback-branch/action.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ runs:
9292
Please do the following:
9393
9494
- [ ] Approve running the full set of PR checks.
95-
- [ ] Approve and merge the PR. When merging the PR, make sure "Create a merge commit" is
96-
selected rather than "Squash and merge" or "Rebase and merge".
95+
- [ ] Approve and merge the PR. When merging the PR, make sure "Create a merge commit" is selected rather than "Squash and merge" or "Rebase and merge".
9796
EOF
9897
)
9998

‎.github/copilot-instructions.md‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
11
# CodeQL Action - Copilot Instructions
22

3+
The CodeQL Action is used in GitHub Actions workflows to run CodeQL scans using the CodeQL CLI.
4+
5+
## Overview
6+
7+
- The repository contains two TypeScript projects.
8+
- The main TypeScript codebase is in the `src` directory, with accompanying unit tests in `.test.ts` files in the same directory.
9+
- The main codebase is compiled to bundled JavaScript code, which is also contained in the repository in the `lib` directory.
10+
- A secondary TypeScript codebase with scripts that are only used for development purposes or by CI is in the `pr-checks` directory. This codebase is not compiled to bundled JavaScript. It is executed directly with `tsx`, which handles compilation internally.
11+
12+
## Review instructions
13+
14+
- When wording review comments, be helpful and friendly. Assume that the PR author has written the code with the best of intentions. Word your comments constructively as suggestions for improvements. Do not word suggestions as commands.
15+
- If you want to comment on a change that you believe will fail a CI check, do not present the CI failure you expect as a fact. Instead, write that you think a change "may" lead to a failure in CI. Suggest that, if such a failure manifests, the changes you are commenting on may be the place responsible for the failure and are worth looking at.
16+
- If a suggestion you make is suitable for a follow-up, such as a refactoring that doesn't change the behaviour or fixing a typo in a comment, mention that it can be addressed in a later PR rather than blocking this one.
17+
- If a change is a net improvement, for example because it improves on an existing limitation of existing code, do not complain about pre-existing problems that remain. You may comment on them, but you should make it clear that the thing you are commenting on is not new by writing e.g. "Not new in this PR, but [..]" followed by your description of the issue and a suggestion that it could be improved at the same time with e.g. "Consider whether this is worth addressing as part of this PR as well."
18+
319
## Generated code
420

5-
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.
21+
The main codebase of 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. The secondary TypeScript codebase has sources in the `pr-checks` directory, which are executed directly with `tsx` and not compiled to JavaScript in the `lib` folder.
622

723
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.
824

925
## Release process
1026

27+
Changes that are merged to the `main` branch are not used in production straight away. Instead, changes from `main` must first be released using the release process, which has to be manually triggered by a staff member. Therefore, it is possible for further changes to be made to the code after some changes have been merged to `main` but before they are released. Once the release process automation is started, a series of PRs are automatically generated:
28+
1129
- A release-PR is a PR which matches all of the following patterns:
30+
1231
- PR title starts with the exact prefix: `Merge main into releases/v`
1332
- Equivalent regex: `^Merge main into releases\/v`
1433
- AND head (source) branch matches the update-branch pattern:
@@ -17,5 +36,5 @@ GitHub Actions workflows in the `.github/workflows` directory whose filenames st
1736
- Regex: `^releases\/v` (e.g. `releases/v3`)
1837

1938
- Consider all files in release-PRs to have already been reviewed and do not review them, except for the following two files:
20-
- `CHANGELOG.md`
21-
- `package.json`
39+
- `CHANGELOG.md`
40+
- `package.json`

‎.github/dependabot.yml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ updates:
88
interval: weekly
99
cooldown:
1010
default-days: 7
11-
exclude:
12-
- "@actions/*"
1311
labels:
1412
- Rebuild
1513
# Ignore incompatible dependency updates
@@ -33,8 +31,6 @@ updates:
3331
interval: weekly
3432
cooldown:
3533
default-days: 7
36-
exclude:
37-
- "actions/*"
3834
labels:
3935
- Rebuild
4036
groups:
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
applyTo: "CHANGELOG.md,src/defaults.json,lib/defaults.json,src/api-compatibility.json"
3+
---
4+
5+
# Merging release, mergeback, and backport PRs
6+
7+
The release process creates a cascade of PRs (`main` → `releases/vN`, then
8+
`releases/vN` → `main` mergeback, then `releases/vN` → `releases/v(N-1)`
9+
backport). These PRs reliably touch `CHANGELOG.md`, `src/defaults.json` /
10+
`lib/defaults.json` (bundle/CLI version bump), and `src/api-compatibility.json`.
11+
12+
Such PRs **must be merged with a merge commit**. Never squash or rebase, as
13+
that breaks the branch linkage the release automation relies on.
14+
15+
When arming auto-merge on these PRs, use `--merge` (e.g. `gh pr merge --merge`),
16+
not `--squash` or `--rebase`.

‎.github/workflows/__all-platform-bundle.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/__autobuild-direct-tracing-with-working-dir.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/__build-mode-autobuild.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/__bundle-toolcache.yml‎

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/__config-input.yml‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/__export-file-baseline-information.yml‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)