LSP4J 0.10.0

[jonahgraham]

This is the Release plan and TODO list for LSP4J release v0.10.0.

Steps for Release

Items at the beginning of development

• Create an Endgame Issue to track the release. As a starting point use documentation/releasing.md.
  • Add the Endgame label and Milestone for the release
  • Make sure any previous edits made to Endgame issues of previous releases are updated in documentation/releasing.md
• Ensure all previous Endgame issues are done.
• Create a New milestone for the release
• Create release on PMI
• 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 that the planned release and which versions of DAP and LSP are support is listed.
• Increment version of all feature.xml, pom.xml and any other place full version is used. (Easiest way is global find and replace, e.g. s/0.9.0/0.10.0/g and review changes.) Ensure that -SNAPSHOT is restored in the gradle/versions.gradle and releng/pom.xml
• Enable sh './releng/deploy-build.sh' in releng/build.Jenkinsfile
• Ensure the CI build is stable - it is always better to release a "Green Dot" build

Items in the days ahead of Release day:

• Schedule the release and if needed schedule a release review on the PMI. A release review is needed every 12 months, not with each release.
• 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 that the planned release and which versions of DAP and LSP are support is listed.

Items on Release day:

• Prepare the repo for release by:
  • removing -SNAPSHOT from gradle/versions.gradle and releng/pom.xml entries in <dependencies> section.
  • disabling sh './releng/deploy-build.sh' in releng/build.Jenkinsfile
  • see commit 328ce8a for a past example
• Push the above change
• Run the CI build
• Mark the build as Keep Forever and add to the description v0.10.0
• Deploy the release by running the Release CI job with parameters:
  • LSP4J_PUBLISH_LOCATION -> updates/releases/0.10.0 ( <-- check version number)
  • PROJECT -> lsp4j-multi-build/job/master
  • LSP4J_BUILD_NUMBER -> the build that was just run above
• Add to the deploy job description v0.10.0
• Promote the staged repository to maven central
  • Login to Nexus
    • To obtain permission add request to OSSRH-26079
  • go to Staging Repositories, after a short delay the staged LSP4J release should appear
  • click the staged LSP4J repo
  • press the Close button. This runs activities, including checking various rules
  • once the rules are done (if successful), press the Release button
  • check https://search.maven.org/search?q=g:org.eclipse.lsp4j to make sure the latest release has arrived - this takes a while, 15 minutes for the files to be on the server and even longer for the search indexes to update
• Update the meta-data on PMI downloads page
• Tag the release. Example: git tag -a v0.10.0 HEAD -m"LSP4J 0.10.0" && git push origin v0.10.0
• Contribute to Simrel. See Simrel contribution example
• Create a release page on github
• Make an announcement on lsp4j-dev based on the release page on github. Example on lsp4j-dev archives
• Update documentation/releasing.md with any changes that may have been made to the release process.
• Create the endgame for the next release right away, especially as version numbers and restoring -SNAPSHOT need to be done right away.

[jonahgraham]

Sometime ago our builds started failing at snapshot deployment phase. I have raised https://bugs.eclipse.org/bugs/show_bug.cgi?id=568506 to try to track down from Webmaster what happened.

[jonahgraham]

GitHub does not send email notifications out for edits AFAIK. I have completed documenting the checklist and as I run through it on Thursday I may make further changes.

[jonahgraham]

The 0.10.0 is done. All checklist items are done, except I am waiting to confirm the maven search index https://search.maven.org/search?q=g:org.eclipse.lsp4j shows the result before closing this endgame.

[jonahgraham]

See #466 for the next release endgame.

[jonahgraham]

the maven search index https://search.maven.org/search?q=g:org.eclipse.lsp4j shows the result before closing this endgame.

It does now. 0.10.0 is done.