You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20-7Lines changed: 20 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,15 +91,28 @@ Alternatively, you can run the tests inside of vscode. There are several vscode
91
91
92
92
## Releasing (write access required)
93
93
94
-
1. Double-check the `CHANGELOG.md` contains all desired change comments
95
-
and has the version to be released with date at the top.
96
-
1. Double-check that the extension `package.json` has the version you intend to release.
97
-
If you are doing a patch release (as opposed to minor or major version) this should already
98
-
be correct.
99
-
1. Trigger a release build on Actions by adding a new tag on branch `main` of the format `vxx.xx.xx`
94
+
1. Double-check the `CHANGELOG.md` contains all desired change comments and has the version to be released with date at the top.
95
+
* Go through all recent PRs and make sure they are properly accounted for.
96
+
* Make sure all changelog entries have links back to their PR(s) if appropriate.
97
+
1. Double-check that the extension `package.json` has 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.
98
+
1. Create a PR for this release:
99
+
* 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.
100
+
* Create a new branch for the release named after the new version. For example: `v1.3.6`
101
+
* Create a new commit with a message the same as the branch name.
102
+
* Create a PR for this branch.
103
+
* Wait for the PR to be merged into `main`
104
+
1. Trigger a release build on Actions by adding a new tag on branch `main` named after the release, as above. Note that when you push to upstream, you will need to fully qualify the ref. A command like this will work:
105
+
106
+
```bash
107
+
git push upstream refs/tags/v1.3.6
108
+
```
109
+
110
+
***IMPORTANT** Make sure you are on the `main` branch and your local checkout is fully updated when you add the tag.
111
+
* If you accidentally add the tag to the wrong ref, you can just force push it to the right one later.
112
+
100
113
1. Monitor the status of the release build in the `Release` workflow in the Actions tab.
101
114
1. Download the VSIX from the draft GitHub release at the top of [the releases page](https://github.com/github/vscode-codeql/releases) that is created when the release build finishes.
102
-
1.Optionally unzip the `.vsix` and inspect its `package.json` to make sure the version is what you expect,
115
+
1. Unzip the `.vsix` and inspect its `package.json` to make sure the version is what you expect,
103
116
or look at the sourceif there's any doubt the right code is being shipped.
104
117
1. Log into the [Visual Studio Marketplace](https://marketplace.visualstudio.com/manage/publishers/github).
105
118
1. Click the `...` menu in the CodeQL row and click **Update**.
0 commit comments