Skip to content

release_plan.md

Latest commit

 

History

History
83 lines (71 loc) · 6.76 KB

release_plan.md

File metadata and controls

83 lines (71 loc) · 6.76 KB

Beta (Monday the week prior to release)

  • Update the version in package.json
  • Run npm install to make sure package-lock.json is up-to-date
  • Update CHANGELOG.md
    • Create a new section for this release
    • Run news (typically python news | code-insiders -)
    • Touch up news entries (and corresponding news entry files)
    • Copy over the "Thanks" section from the previous release
  • Update ThirdPartyNotices-Distribution.txt
    • Run tpn (typically python tpn --npm package-lock.json --npm-overrides package.datascience-ui.dependencies.json --config tpn/distribution.toml ThirdPartyNotices-Distribution.txt)
    • Register any Python changes with OSPO
  • Update ThirdPartyNotices-Repository.txt and register any changes with OSPO
  • Open appropriate documentation issues
  • Check that component governance is happy (requires beta PR to have been merged)

Release candidate (Monday before release)

  • Ensure all new features are tracked via telemetry
  • Announce a code freeze
  • Create a branch against master for a pull request
  • Update the version in package.json
  • Run npm install to make sure package-lock.json is up-to-date
  • Update CHANGELOG.md
    • Update version and date for the release section
    • Run news (typically python news --final | code-insiders -; the --final flag is on purpose as no more changes are expected)
    • Touch up news entries (and corresponding news entry files)
    • Check that the "Thanks" section is up-to-date
  • Update ThirdPartyNotices-Distribution.txt
    • Run tpn (typically python tpn --npm package-lock.json --npm-overrides package.datascience-ui.dependencies.json --config tpn/distribution.toml ThirdPartyNotices-Distribution.txt)
    • Register any Python changes with OSPO
  • Update ThirdPartyNotices-Repository.txt and register any changes with OSPO
  • Merge pull request into master
  • Delete the release branch in the repo
  • Create a new release branch from master
  • Bump the version number to the next release in the master branch
    • package.json
    • package-lock.json
  • Announce the code freeze is over
  • Open appropriate documentation issues
  • Begin drafting a blog post
  • Make sure component governance is happy (requires RC PR to have been merged)

Final (near a VS Code release)

Preparation

  • Make sure the appropriate pull requests for the documentation -- including the WOW page -- are ready
  • Create a branch against release for a pull request
  • Update the version in package.json
  • 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 (typically python news --final | code-insiders -)
    • Check that the "Thanks" section is up-to-date
  • Update ThirdPartyNotices-Distribution.txt
    • Run tpn (typically python tpn --npm package-lock.json --npm-overrides package.datascience-ui.dependencies.json --config tpn/distribution.toml ThirdPartyNotices-Distribution.txt)
    • Register any Python changes with component governance
  • Update ThirdPartyNotices-Repository.txt and register any changes with OSPO
  • Merge pull request into release
  • Make sure component governance is happy

Release

  • Make sure CI is passing
  • Generate the final .vsix file
  • Make sure no extraneous files are being included in the .vsix file (make sure to check for hidden files)
  • Upload the final .vsix file to the marketplace
  • Publish documentation changes
  • Publish the blog post
  • Create a release on GitHub (which creates an appropriate git tag)
  • Determine if a hotfix is needed
  • Merge release back into master

Prep for the next release

Clean up after this release