Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 3.33 KB

HOW_TO_RELEASE.md

File metadata and controls

58 lines (41 loc) · 3.33 KB
Raw

How To: Release NatTable

This document describes the process on how to release Nebula NatTable.

Preparation

  • In case of a major or minor release, ensure that the DEPENDENCIES information is up to date.
    • Either directly update it via the Eclipse Dash License Tool mvn org.eclipse.dash:license-tool-plugin:license-check -Ddash.summary=DEPENDENCIES -Dtycho.target.eager=true
    • Or run the license-check profile which also generates an SBOM mvn clean verify -Plicense-check -DskipTests=true -Dtycho.target.eager=true
    • In case of unknown or restricted entries in the DEPENDENCIES, create IP Team Review Requests via
    mvn org.eclipse.dash:license-tool-plugin:license-check -Ddash.summary=DEPENDENCIES -Dtycho.target.eager=true -Ddash.iplab.token=<TOKEN>
  • Ensure that everything is checked in to the master branch
  • Create and push a release branch for the version that should be released (e.g. releases/2.0.2)
  • Create a release in the project management: https://projects.eclipse.org/node/1463/create-release
    • Ensure that the project information is updated (e.g. set the correct Release Type)
  • Create a tag for the new version based on the last commit
  • Ensure that there is a milestone for the release and that all issues that are resolved with this milestone are correctly assigned.

Release to Eclipse

Release to Maven Central

  • Update the version to remove -SNAPSHOT and .qualifier from any version numbers in the release branch via mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=VERSION

  • Trigger the Jenkins Job to release to Maven Central: https://ci.eclipse.org/nattable/job/nattable-release-maven/

  • Build with parameters

    • Select the branch that should be build and released

  • Once the build finishes successfully, you have deployed the artifacts to the OSSRH staging area. According to the documentation you now need to release the deployment to Maven Central.

    • Login to https://oss.sonatype.org/
    • In the left menu check for Build Promotion - Staging Repositories
    • Select your repository and validate if it meets your expectations
    • If everything is correct Close the repository, otherwise Drop it and fix any issues
    • Once it is closed, press the Release button to trigger the release to the Central repository

Release to GitHub

  • Create a release on GitHub and upload the release artifacts from the Eclipse build

Finalization

  • Update the version in the master branch via mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=NEW_VERSION_NUMBER.qualifier

Update the website

  • Update content/download.md to add the new version for downloading
  • Update content/examples/index.md to correct the links to the examples applications
  • Create a news or New & Noteworthy page in content/news to add the news about the new release

More details on the publishing process of Eclipse projects to Maven Central can be found here