April release plan

[IanMatthewHuff]

Prerequisites

• Python 3.7 and higher
• run python3 -m pip install --user -r news/requirements.txt

Release candidate (Wednesday, March 24th)

• Update Component Governance (Click on "microsoft/vscode-jupyter" on that page). Notes are in the OneNote under Python VS Code -> Dev Process -> Component Governance.
  • Provide details for any automatically detected npm dependencies
  • Manually add any repository dependencies
• Create new release branch with format release-YYYY.MM
  • Create a pull request against release-YYYY.MM for changes
  • Run npm install to make sure package-lock.json is up-to-date
  • Update CHANGELOG.md
    • Run news (typically python news --final --update CHANGELOG.md | code-insiders -)
    • Copy over the "Thanks" section from the previous release into the "Thanks" section for the new release
    • Make sure the "Thanks" section is up-to-date (e.g. compare to versions in requirements.txt)
    • Touch up news entries (e.g. add missing periods)
    • Check the Markdown rendering to make sure everything looks good
  • Update ThirdPartyNotices-Distribution.txt by using https://dev.azure.com/vscode-python-datascience/vscode-python-datascience/_componentGovernance and downloading the notice (Notes for this process are in the Team OneNote under Python VS Code -> Dev Process -> Third-Party Notices / TPN file)
  • Update ThirdPartyNotices-Repository.txt as appropriate. This file is manually edited so you can check with the teams if anything needs to be added here.
  • Merge pull request into release-YYYY.MM
• Update the release branch
  • If there are release branches that are two versions old (e.g. release-2020.[current month - 2]) you can delete them at this time
• Update main post-release
  • Bump the version number to the next monthly ("YYYY.MM.0") release in the main branch
    • package.json
    • package-lock.json
  • Create a pull request against main
  • Merge pull request into main
• GDPR bookkeeping (@greazer) (🤖; Notes in OneNote under Python VS Code -> Dev Process -> GDPR)
• Open appropriate documentation issues
  • new features
  • settings changes
  • etc. (ask the team)
• 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.
• Begin drafting a blog post. Contact the PM team for this.
• Ask CTI to test the release candidate

Final (Monday, XXX XX)

Preparation

• Make sure the appropriate pull requests for the documentation -- including the WOW page -- are ready
• Final updates to the release-YYYY.MM branch
  • Create a branch against release-YYYY.MM for a pull request
  • Update the version in package.json to remove the -rc (🤖)
  • Run npm install to make sure package-lock.json is up-to-date (the only update should be the version number if package-lock.json has been kept up-to-date) (🤖)
  • Update CHANGELOG.md (🤖)
    • Update version and date for the release section
    • Run news and copy-and-paste new entries (typically python news --final | code-insiders -; quite possibly nothing new to add)
  • Update ThirdPartyNotices-Distribution.txt by using https://tools.opensource.microsoft.com/notice (🤖; see team notes)
  • Update ThirdPartyNotices-Repository.txt manually if necessary
  • Create pull request against release-YYYY.MM (🤖)
  • Merge pull request into release-YYYY.MM
• Make sure component governance is happy

Release

• Publish the release
  • For manual
    • Download the Release VSIX & Make sure no extraneous files are being included in the .vsix file (make sure to check for hidden files)
    • Go to https://marketplace.visualstudio.com/manage/publishers/ms-toolsai?noPrompt=true and upload the VSIX
      • If there's errors, try diffing against old vsix that worked
    • Go to https://github.com/microsoft/vscode-jupyter/releases and add a new release
      • Tag is version number
      • Branch is release branch
      • Copy contents of release branch changelog into the release (just copy the markdown)
      • Save
  • For automated (assuming it's working)
    • Go into the Publish Extension workflow and manually run this workflow to publish the extension to the marketplace.
    • Edit the GitHub release
    • Edit the tag to match the version of the released extension
• Publish documentation changes
• Publish the blog post
• Determine if a hotfix is needed
• Merge release-YYYY.MM back into main. Don't overwrite the version in package.json. (🤖)

Clean up after this release

• Go through info needed issues and close any that have no activity for over a month (🤖)
• GDPR bookkeeping (🤖)

Prep for the next release

• Create a new release plan (🤖)
• (Un-)pin release plan issues (🤖)