Skip to content

Commit f47defc

Browse files
IanMatthewHuffIan Huff
andauthored
release plan changes (microsoft#13415)
Co-authored-by: Ian Huff <ianhuff@ravikun-dev2.redmond.corp.microsoft.com>
1 parent 08e4074 commit f47defc

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

.github/release_plan.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,80 +5,81 @@
55

66
# Release candidate (Monday, XXX XX)
77

8-
- [ ] Announce the code freeze (not just to team but also to debugger and language server)
8+
- [ ] Announce the code freeze on both Teams and e-mail, leave enough time for teams to surface any last minute issues that need to get in before freeze. Make sure debugger and Language Server teams are looped in as well.
99
- [ ] Update master for the release
1010
- [ ] Create a branch against `master` for a pull request
1111
- [ ] Change the version in [`package.json`](https://github.com/Microsoft/vscode-python/blob/master/package.json) from a `-dev` suffix to `-rc` (🤖)
1212
- [ ] Run `npm install` to make sure [`package-lock.json`](https://github.com/Microsoft/vscode-python/blob/master/package.json) is up-to-date (🤖)
1313
- [ ] Extension will pick up latest version of `debugpy`. If you need to pin to a particular version see `install_debugpy.py`.
14-
- [ ] Update `languageServerVersion` in `package.json` to point to the latest version of the [Language Server](https://github.com/Microsoft/python-language-server).
14+
- [ ] Update `languageServerVersion` in `package.json` to point to the latest version of the [Language Server](https://github.com/Microsoft/python-language-server). Check with the language server team if this needs updating.
1515
- [ ] Update [`CHANGELOG.md`](https://github.com/Microsoft/vscode-python/blob/master/CHANGELOG.md) (🤖)
1616
- [ ] Run [`news`](https://github.com/Microsoft/vscode-python/tree/master/news) (typically `python news --final --update CHANGELOG.md | code-insiders -`)
17-
- [ ] Copy over the "Thanks" section from the previous release
17+
- [ ] Copy over the "Thanks" section from the previous release into the "Thanks" section for the new release
1818
- [ ] Make sure the "Thanks" section is up-to-date (e.g. compare to versions in [`requirements.txt`](https://github.com/microsoft/vscode-python/blob/master/requirements.txt))
1919
- [ ] Touch up news entries (e.g. add missing periods)
2020
- [ ] Check the Markdown rendering to make sure everything looks good
2121
- [ ] Add any relevant news entries for `debugpy` and the language server if they were updated
22-
- [ ] Update [`ThirdPartyNotices-Distribution.txt`](https://github.com/Microsoft/vscode-python/blob/master/ThirdPartyNotices-Distribution.txt) by using https://tools.opensource.microsoft.com/notice (see team notes)
23-
- [ ] Update [`ThirdPartyNotices-Repository.txt`](https://github.com/Microsoft/vscode-python/blob/master/ThirdPartyNotices-Repository.txt) as appropriate
22+
- [ ] Update [`ThirdPartyNotices-Distribution.txt`](https://github.com/Microsoft/vscode-python/blob/master/ThirdPartyNotices-Distribution.txt) by using https://tools.opensource.microsoft.com/notice (Notes for this process are in the Team OneNote under Python VS Code -> Dev Process -> Third-Party Notices / TPN file)
23+
- [ ] Update [`ThirdPartyNotices-Repository.txt`](https://github.com/Microsoft/vscode-python/blob/master/ThirdPartyNotices-Repository.txt) as appropriate. This file is manually edited so you can check with the teams if anything needs to be added here.
2424
- [ ] Create a pull request against `master` (🤖)
2525
- [ ] Merge pull request into `master`
2626
- [ ] Update the [`release` branch](https://github.com/microsoft/vscode-python/branches)
27-
- [ ] Delete the `release` branch in the repo
28-
- [ ] Create a new `release` branch from `master`
29-
- (alternately, force-push the master branch to the GitHub "release" branch)
30-
- [ ] (if necessary) Request that the branch be set anew as "protected"
27+
- [ ] If there are `release` branches that are two versions old (e.g. release-2020.[current month - 2]) you can delete them at this time
28+
- [ ] Create a new `release-YYYY.MM` branch from `master`
3129
- [ ] Update master post-release (🤖)
32-
- [ ] Bump the version number to the next monthly ("YYYY.M.0-dev") release in the `master` branch
30+
- [ ] Bump the version number to the next monthly ("YYYY.MM.0-dev") release in the `master` branch
3331
- [ ] `package.json`
3432
- [ ] `package-lock.json`
3533
- [ ] Create a pull request against `master`
3634
- [ ] Merge pull request into `master`
37-
- [ ] Announce the code freeze is over
38-
- [ ] Update [Component Governance](https://dev.azure.com/ms/vscode-python/_componentGovernance) (Click on "microsoft/vscode-python" on that page)
35+
- [ ] Announce the code freeze is over on the same channels
36+
- [ ] Update [Component Governance](https://dev.azure.com/ms/vscode-python/_componentGovernance) (Click on "microsoft/vscode-python" on that page). Notes are in the OneNote under Python VS Code -> Dev Process -> Component Governance.
3937
- [ ] Provide details for any automatically detected npm dependencies
4038
- [ ] Manually add any repository dependencies
41-
- [ ] GDPR bookkeeping (@brettcannon) (🤖; see team notes)
39+
- [ ] GDPR bookkeeping (@brettcannon) (🤖; Notes in OneNote under Python VS Code -> Dev Process -> GDPR)
4240
- [ ] Open appropriate [documentation issues](https://github.com/microsoft/vscode-docs/issues?q=is%3Aissue+is%3Aopen+label%3Apython)
4341
- new features
4442
- settings changes
4543
- etc. (ask the team)
46-
- [ ] Schedule a bug bash
47-
- [ ] Begin drafting a [blog](http://aka.ms/pythonblog) post
44+
- [ ] Schedule a bug bash. Aim for close after freeze so there is still time to fix release bugs before release. Ask teams before bash for specific areas that need testing.
45+
- [ ] Begin drafting a [blog](http://aka.ms/pythonblog) post. Contact the PM team for this.
4846
- [ ] Ask CTI to test the release candidate
4947

5048
# Final (Monday, XXX XX)
5149

5250
## Preparation
5351

5452
- [ ] Make sure the [appropriate pull requests](https://github.com/microsoft/vscode-docs/pulls) for the [documentation](https://code.visualstudio.com/docs/python/python-tutorial) -- including the [WOW](https://code.visualstudio.com/docs/languages/python) page -- are ready
55-
- [ ] final updates to the `release` branch
56-
- [ ] Create a branch against `release` for a pull request
57-
- [ ] Update the version in [`package.json`](https://github.com/Microsoft/vscode-python/blob/master/package.json) (🤖)
53+
- [ ] Final updates to the `release-YYYY.MM` branch
54+
- [ ] Create a branch against `release-YYYY.MM` for a pull request
55+
- [ ] Update the version in [`package.json`](https://github.com/Microsoft/vscode-python/blob/master/package.json) to remove the `-rc` (🤖)
5856
- [ ] Run `npm install` to make sure [`package-lock.json`](https://github.com/Microsoft/vscode-python/blob/master/package.json) is up-to-date (the only update should be the version number if `package-lock.json` has been kept up-to-date) (🤖)
5957
- [ ] Update [`CHANGELOG.md`](https://github.com/Microsoft/vscode-python/blob/master/CHANGELOG.md) (🤖)
6058
- [ ] Update version and date for the release section
6159
- [ ] Run [`news`](https://github.com/Microsoft/vscode-python/tree/master/news) and copy-and-paste new entries (typically `python news --final | code-insiders -`; quite possibly nothing new to add)
6260
- [ ] Update [`ThirdPartyNotices-Distribution.txt`](https://github.com/Microsoft/vscode-python/blob/master/ThirdPartyNotices-Distribution.txt) by using https://tools.opensource.microsoft.com/notice (🤖; see team notes)
6361
- [ ] Update [`ThirdPartyNotices-Repository.txt`](https://github.com/Microsoft/vscode-python/blob/master/ThirdPartyNotices-Repository.txt) manually if necessary
64-
- [ ] Create pull request against `release` (🤖)
65-
- [ ] Merge pull request into `release`
62+
- [ ] Create pull request against `release-YYYY.MM` (🤖)
63+
- [ ] Merge pull request into `release-YYYY.MM`
6664
- [ ] Make sure component governance is happy
6765

6866
## Release
6967

7068
- [ ] Publish the release via Azure DevOps
71-
- [ ] Make sure [CI](https://github.com/Microsoft/vscode-python/blob/master/CONTRIBUTING.md) is passing
72-
- [ ] Make sure the "Upload" stage on the release page succeeded
69+
- [ ] Make sure [CI](https://github.com/Microsoft/vscode-python/blob/master/CONTRIBUTING.md) is passing. Try a re-run on any failing CI test stages. If tests still won't pass contact the owning team.
70+
- [ ] On Azure DevOps on the page for the CI run after it succeeds there will now be a "Releases" tab which is populated with a release entry. Click that entry to go to the release page, which shows the "Upload" and "Publish" stages
71+
- [ ] Click the deploy button on the "Upload" stage and make sure that it succeeds
7372
- [ ] Make sure no extraneous files are being included in the `.vsix` file (make sure to check for hidden files)
74-
- [ ] Deploy the "Publish" stage
73+
- [ ] Click the deploy button on the "Publish" stage, this will push out the release to the public
74+
- [ ] From a VSCode instance uninstall the python extension. After the publish see if the new version is available from the extensions tab. Download it and quick sanity check to make sure the extension loads.
7575
- [ ] Create a [GitHub release](https://github.com/microsoft/vscode-python/releases)
76-
- [ ] Have tag match the released version
77-
- [ ] Copy the changelog entry for the release as the description
76+
- [ ] The previous publish step should have created a release here, but it needs to be edited
77+
- [ ] Edit the tag to match the version of the released extension
78+
- [ ] Copy the changelog entry into the release as the description
7879
- [ ] Publish [documentation changes](https://github.com/Microsoft/vscode-docs/pulls?q=is%3Apr+is%3Aopen+label%3Apython)
7980
- [ ] Publish the [blog](http://aka.ms/pythonblog) post
8081
- [ ] Determine if a hotfix is needed
81-
- [ ] Merge `release` back into `master` (🤖)
82+
- [ ] Merge `release-YYYY.MM` back into `master`. Don't overwrite the master `-dev` version in package.json. (🤖)
8283

8384
## Clean up after _this_ release
8485

0 commit comments

Comments
 (0)