Skip to content

Commit 2fee4cc

Browse files
authored
Merge pull request #292 from github/jcreedcmu-patch-1
Expand release documentation
2 parents 77b3f0a + 9d25049 commit 2fee4cc

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,23 @@ Alternatively, you can run the tests inside of vscode. There are several vscode
144144

145145
## Releasing (write access required)
146146

147+
1. Double-check the `CHANGELOG.md` contains all desired change comments
148+
and has the version to be released with date at the top.
149+
1. Double-check that the extension `package.json` has the version you intend to release.
150+
If you are doing a patch release (as opposed to minor or major version) this should already
151+
be correct.
147152
1. Trigger a release build on Actions by adding a new tag on master of the format `vxx.xx.xx`
148153
1. Monitor the status of the release build in the `Release` workflow in the Actions tab.
149-
1. Download the VSIX from the draft GitHub release that is created when the release build finishes.
154+
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.
155+
1. Optionally unzip the `.vsix` and inspect its `package.json` to make sure the version is what you expect,
156+
or look at the source if there's any doubt the right code is being shipped.
150157
1. Log into the [Visual Studio Marketplace](https://marketplace.visualstudio.com/manage/publishers/github).
151158
1. Click the `...` menu in the CodeQL row and click **Update**.
152159
1. Drag the `.vsix` file you downloaded from the GitHub release into the Marketplace and click **Upload**.
153-
1. Publish the draft GitHub release and confirm the new release is marked as the latest release at <https://github.com/github/vscode-codeql/releases>.
160+
1. Go to the draft GitHub release, click 'Edit', add some summary description, and publish it.
161+
1. Confirm the new release is marked as the latest release at <https://github.com/github/vscode-codeql/releases>.
162+
1. If documentation changes need to be published, notify documentation team that release has been made.
163+
1. Review and merge the version bump PR that is automatically created by Actions.
154164

155165
## Resources
156166

0 commit comments

Comments
 (0)