Vscode-python: Release plan for 2020.8

[brettcannon]

Prerequisites

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

Release candidate (Wednesday, Aug 05)

• [x] Announce the code freeze (not just to team but also to debugger and language server)
• [x] Update master for the release
  
  
  
  • [x] Create a branch against master for a pull request
  
  
  • [x] Change the version in package.json from a -dev suffix to -rc (🤖)
  
  
  • [x] Run npm install to make sure package-lock.json is up-to-date (🤖)
  
  
  • [x] Extension will pick up latest version of debugpy. If you need to pin to a particular version see install_debugpy.py.
  
  
  • [x] Update languageServerVersion in package.json to point to the latest version of the Language Server.
  
  
  • [x] Update CHANGELOG.md (🤖)
    
    
    
    
    
    • [x] Run news (typically python news --final --update CHANGELOG.md | code-insiders -)
    
    
    
    • [x] Copy over the "Thanks" section from the previous release
    
    
    
    • [x] Make sure the "Thanks" section is up-to-date (e.g. compare to versions in requirements.json)
    
    
    
    • [x] Touch up news entries (e.g. add missing periods)
    
    
    
    • [x] Check the Markdown rendering to make sure everything looks good
    
    
    
    • [x] Add any relevant news entries for debugpy and the language server if they were updated
    
    
    
  
  
  • [x] Update ThirdPartyNotices-Distribution.txt by using https://tools.opensource.microsoft.com/notice (see team notes)
  
  
  • [x] Update ThirdPartyNotices-Repository.txt as appropriate
  
  
  • [x] Create a pull request against master (🤖)
  
  
  • [x] Merge pull request into master
  
  
• [x] Update the release branch
  
  
  
  • [x] Delete the release branch in the repo
  
  
  • [x] Create a new release branch from master
  
  
  • (alternately, force-push the master branch to the GitHub "release" branch)
  
  
  • [x] (if necessary) Request that the branch be set anew as "protected"
  
  
• [x] Update master post-release (🤖)
  
  
  
  • [x] Bump the version number to the next monthly ("YYYY.M.0-dev") release in the master branch
    
    
    
    
    
    • [x] package.json
    
    
    
    • [x] package-lock.json
    
    
    
  
  
  • [x] Create a pull request against master
  
  
  • [x] Merge pull request into master
  
  
• [x] Announce the code freeze is over
• [x] Update Component Governance (Click on "microsoft/vscode-python" on that page)
  
  
  
  • [x] Provide details for any automatically detected npm dependencies
  
  
  • [x] Manually add any repository dependencies
  
  
• [x] GDPR bookkeeping (@brettcannon) (🤖; see team notes)
• [ ] Open appropriate documentation issues
  
  
  
  • new features
  
  
  • settings changes
  
  
  • etc. (ask the team)
  
  
• [ ] Begin drafting a blog post
• [x] Ask CTI to test the release candidate

Final (Wednesday, Aug 12)

Preparation

• [ ] Make sure the appropriate pull requests for the documentation -- including the WOW page -- are ready
• [ ] final updates to the release branch
  
  
  
  • [x] Create a branch against release for a pull request
  
  
  • [x] Update the version in package.json (🤖)
  
  
  • [x] 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 (🤖)
    
    
    
    
    
    • [x] Update version and date for the release section
    
    
    
    • [x] Run news and copy-and-paste new entries (typically python news --final | code-insiders -; quite possibly nothing new to add)
    
    
    
    • [x] Add pylance to the list of projects we rely on under the "Thanks" section
    
    
    
  
  
  • [x] Update ThirdPartyNotices-Distribution.txt by using https://tools.opensource.microsoft.com/notice (🤖; see team notes)
  
  
  • [x] Update ThirdPartyNotices-Repository.txt manually if necessary
  
  
  • [x] Create pull request against release (🤖)
  
  
  • [x] Merge pull request into release
  
  
• [x] Make sure component governance is happy

Release

• [x] Publish the release via Azure DevOps
  
  
  
  • [x] Make sure CI is passing
  
  
  • [x] Make sure the "Upload" stage on the release page succeeded
  
  
  • [x] Make sure no extraneous files are being included in the .vsix file (make sure to check for hidden files)
  
  
  • [x] Deploy the "Publish" stage
  
  
• [x] Create a GitHub release
  
  
  
  • [x] Have tag match the released version
  
  
  • [x] Copy the changelog entry for the release as the description
  
  
• [x] Publish documentation changes
• [x] Publish the blog post
• [x] Determine if a hotfix is needed
• [x] Merge release back into master (🤖)

Clean up after _this_ release

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

Prep for the _next_ release

• [x] Create a new release plan (🤖)
• [x] [(Un-)pin](https://help.github.com/en/articles/pinning-an-issue-to-your-repository) release plan issues (🤖)

[kimadeline]

Copying @luabud's comment from https://github.com/microsoft/vscode-python/pull/13010#issuecomment-660301873 in case this hasn't been done in the previous point release:

we should also update our changelog in the list of supported projects at some point

[luabud]

@kimadeline thanks for bringing it up!

@brettcannon I updated your comment to include a checkbox under "update changelog" so we don't forget to do that for this release plan.

[brettcannon]

We can also just drop the "Thanks" section if we think no one is reading it.

[luabud]

I am reading it 😂

[yousefabuz17]

THEIR IS A HUGE BUG IN THIS NEW VERSION:

user inputs are not accepted in the terminal. If you ask the user what their age is, then when you type the age and click enter nothing happens. I found downgrading this one update behind solved the solution but took me hours to figure it out lol

[brettcannon]

FYI the issue @yousefabuz17 reported is a duplicate of https://github.com/microsoft/debugpy/issues/370.

[IanMatthewHuff]

Whoops, realized that I didn't close this after the release. Closing now.

[brettcannon]

@IanMatthewHuff @karthiknadig I left this open because the "merge release into main" step was never checked off. Did that ever occur?

[brettcannon]

(And I was waiting for that before doing the last two steps of creating a new release plan.)

[karthiknadig]

Not from the latest release (last week). I am preparing a merge back PR right now.

[IanMatthewHuff]

My apologies. I did do the merge from release back into main for the initial release (not the point release that @karthiknadig) mentioned. Just forgot to check off the issue.