Skip to content

Latest commit

 

History

History
45 lines (38 loc) · 3.75 KB

RELEASING.md

File metadata and controls

45 lines (38 loc) · 3.75 KB
Raw

This is the Release plan and TODO list for CDT LSP.

Steps for Release

Items at the beginning of development

  • Create an Endgame Issue to track the release. As a starting point use RELEASING.md.
  • Create a New milestone for the release, and if available add a due date
    • Apply the milestone to the endgame issue
  • Ensure all previous Endgame issues are done.
  • Update version numbers on master branch (after the release branch was created), this is generally the next minor version (or major version if that is what the committers on the project agree) and applies to the following types of files:
    • feature.xml version
    • pom.xml version
    • It does not apply to versions in MANIFEST.MF which follow API rules.
  • Ensure the CI build is stable - it is always better to release a "Green Dot" build

Items in the days ahead of Release day:

  • Create release on PMI (e.g. 1.0.0 (CDT LSP))
    • Fill in the Review Documentation -> New & Noteworthy URL with the CHANGELOG.md
  • Check CHANGELOG.md is up to date. The changelog should have a version entry, release date, API Breakages and other information consistent with current entries in the changelog.
  • Check README.md is up to date, in particular:
    • the planned release and which versions of main dependencies are supported in the version support table
    • screenshots are up to date and consistent
    • try it out steps are correct and where suitable versions are up to date
  • Check all closed PRs and Issues to make sure their milestone is set. This search may be useful to identify such closed issues
  • Create a branch for the release
  • Create the endgame for the next scheduled release right away and update the versions on the master branch

Items on Release day: