Skip to content

Releasing

Max Bechtold edited this page Nov 12, 2017 · 35 revisions

Prerequisites

  • Maven 3
  • Git
  • GitHub account with owner rights on this project
  • GitHub personal access token (privileges public_repo, repo:status, repo_deployment, user:email) configured in Maven's settings.xml, cf. https://github.com/github/maven-plugins

Steps

Document the release

  1. Check and complete the Release Notes (in org.projectusus.documentation/Release Notes). Commit & push.
  2. Determine the version number to release.
    You can look at the parent POM if you are unsure. If it says 0.7.3-SNAPSHOT the version number will most likely be 0.7.3.
    If you are not content with this version, first update the SNAPSHOT version using mvn org.eclipse.tycho:tycho-versions-plugin:set-version -Dtycho.mode=maven -DnewVersion=A.B.C-SNAPSHOT (where A.B.C could be 1.0.0)
  3. Create and push a git tag for the version, name it vA.B.C (replace A.B.C with the real version number): git tag -a vA.B.C -m "tag vA.B.C"

Build and append to update site

  1. In the repository root directory, execute mvn clean install.
    If some tests fail when run in Maven that work in Eclipse, blame Maven Tycho and run mvn clean install -DskipTests.
  2. Change into org.projectusus.updatesite and execute mvn clean deploy -Drelease.version=A.B.C (replace A.B.C with the real version number).

Ship release-only update site

  1. Go to org.projectusus.updatesite-latest and run mvn clean install. This will create a ZIP called org.projectusus.updatesite-latest-A.B.C-SNAPSHOT.zip in the target folder.
  2. Rename the file to org.projectusus.updatesite-latest-A.B.C.zip (replace A.B.C with the real version number).
  3. Create a new release on GitHub for the previously created tag.
  4. Upload org.projectusus.updatesite-latest-A.B.C.zip.

Prepare for next release

  1. Decide which version number the next release should have.
    Normally, this is simply done by incrementing the last part of the version number by one.
  2. Go back to the root folder and run mvn org.eclipse.tycho:tycho-versions-plugin:set-version -Dtycho.mode=maven -DnewVersion=A.B.D-SNAPSHOT (replace A.B.D with the number of the next version you are going to work on).
  3. Commit and push the changed files to GitHub: git commit -a -m "Release A.B.C"; git push origin master

Spread the word

  1. Update the version in the Eclipse Marketplace.
  2. Send a tweet!
  3. Celebrate!

Clone this wiki locally