|
1 | 1 | # Releasing (write access required) |
2 | 2 |
|
3 | | -1. Go through [our test plan](./test-plan.md) to ensure that the extension is working as expected. |
4 | 3 | 1. Double-check the `CHANGELOG.md` contains all desired change comments and has the version to be released with date at the top. |
5 | 4 | * Go through all recent PRs and make sure they are properly accounted for. |
6 | 5 | * Make sure all changelog entries have links back to their PR(s) if appropriate. |
|
17 | 16 | * `.github/workflows/release.yml` - the "node-version: <version>" setting |
18 | 17 | 1. Double-check that the extension `package.json` and `package-lock.json` have the version you intend to release. If you are doing a patch release (as opposed to minor or major version) this should already be correct. |
19 | 18 | 1. Create a PR for this release: |
20 | | - * This PR will contain any missing bits from steps 1 and 2. Most of the time, this will just be updating `CHANGELOG.md` with today's date. |
| 19 | + * This PR will contain any missing bits from steps 1, 2 and 3. Most of the time, this will just be updating `CHANGELOG.md` with today's date. |
21 | 20 | * Create a new branch for the release named after the new version. For example: `v1.3.6` |
22 | 21 | * Create a new commit with a message the same as the branch name. |
23 | 22 | * Create a PR for this branch. |
24 | 23 | * Wait for the PR to be merged into `main` |
| 24 | +1. Switch to `main` branch and pull latest changes |
| 25 | +1. Lock the `main` branch. |
| 26 | + * Go to the [branch protection rules for the `main` branch](https://github.com/github/vscode-codeql/settings/branch_protection_rules/16447115) |
| 27 | + * Select "Lock branch" |
| 28 | + * Click "Save changes" |
| 29 | +1. Ensure that no PRs have been merged since the release PR that you merged. If there were, you might need to unlock `main` temporarily and update the CHANGELOG again. |
| 30 | +1. Build the extension `npm run build` and install it on your VS Code using "Install from VSIX". |
| 31 | +1. Go through [our test plan](./test-plan.md) to ensure that the extension is working as expected. |
25 | 32 | 1. Switch to `main` and add a new tag on the `main` branch with your new version (named after the release), e.g. |
26 | 33 | ```bash |
27 | 34 | git checkout main |
|
32 | 39 | ```bash |
33 | 40 | git tag -d badly-named-tag |
34 | 41 | ``` |
| 42 | +1. Unlock the main branch |
| 43 | + * Go to the [branch protection rules for the `main` branch](https://github.com/github/vscode-codeql/settings/branch_protection_rules/16447115) |
| 44 | + * Deselect "Lock branch" |
| 45 | + * Click "Save changes" |
35 | 46 | 1. Push the new tag up: |
36 | 47 |
|
37 | 48 | a. If you're using a fork of the repo: |
|
0 commit comments