Difference between revisions of "Releasing Tycho"

Revision as of 05:58, 7 November 2019

This page describes the steps necessary to create releases of the Tycho project.

1. Make sure all bugs have the correct target milestone for this release
2. Schedule a new release and generate the IP log on projects.eclipse.org
3. Prepare the Tycho/Release Notes which should provide a quick overview of new features and bug fixes
4. Link the N&N to the release review
5. At least once per year, a review is required. In that case, send email to technology-pmc@eclipse.org to review the release docs.
6. Update versions using
   mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=...
7. Commit version change, and create a git tag tycho-<VERSION> on this commit
8. Update versions (same as above) to next -SNAPSHOT development version and push commit to master branch
9. Create the new version and milestone in the bugzilla manager
10. Make sure you have everything setup (GPG installed!) for deploying to the Nexus OSS repository, see guide
11. Add your credentials for server sonatype-nexus-staging in ~/.m2/settings.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
   <!-- ... -->
   <servers>
    <server>
      <id>sonatype-nexus-staging</id>
      <username>mickael.istria</username>
      <password>securePassword</password> <!-- use `mvn --encrypt-password` to not store plain text -->
    </server>
    <!-- ... -->
   </servers>
</settings>

1. Checkout the tag version tycho-<VERSION> so current commit is the tag.
2. Sync to release commit and deploy to nexus staging repository:
   mvn clean deploy -Prelease -DforgeReleaseId=sonatype-nexus-staging -DforgeReleaseUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/
3. Generate site docs using mvn clean install site site:stage and check the result from target/staging
4. On https://oss.sonatype.org/#stagingRepositories , Close the staging repository and announce the temporary stage URL on tycho-user@eclipse.org:

Subject: please test staged tycho <VERSION>

Tycho release <VERSION&> has been staged. For details of new features and bugfixes, see release notes [1].
Please help by testing the staged build. To use it, change your tycho version to <VERSION> and add snippet [2] to your pom.

We plan to promote this release in one week unless major regressions are found.

Regards,
Tycho team

[1] http://wiki.eclipse.org/Tycho/Release_Notes/<VERSION>
[2]
  <pluginRepositories>
    <pluginRepository>
      <id>tycho-staged</id>
      <url><NEXUS_OSS_STAGING_URL></url
    </pluginRepository>
  </pluginRepositories>

1. Prepare update tycho-demo projects to the latest release and push the change as a review to Gerrit
2. Prepare Update yo the webite, using git repo https://git.eclipse.org/c/www.eclipse.org/tycho.git/
   1. Change versions on main page
   2. Update the New and Noteworthy section
   3. Prepare sitedocs: Copy the local site docs folders target/staging/sitedocs to the existing sitedocs folder
   4. Submit those change as Gerrit review (don't merge yet)
3. ... Wait until review date (usually a week later)...
4. After ~1 week of testing, promote the stage repository on https://oss.sonatype.org/
   1. Only drop the staging repository once the artifacts have reached Maven central.
5. Push the release tags to git: git push origin --tags
6. Browse the Tycho wiki pages to update any hardcoded tycho versions to the latest version
7. Merge the update to org.eclipse.tycho-demo and website in Gerrit
8. Prepare next stream
   1. Set versions in <n+1>-SNAPSHOT
   2. Commit to Gerrit
   3. When green, merge org.eclipse.tycho change
   4. Then build https://ci.eclipse.org/tycho/job/tycho-build/
9. Announce the release
   1. Find out who contributed to the release:

git log --pretty=format:%an tycho-0.<n>..tycho-0.<n+1> | sort | uniq
git log --grep="Also-[bB]y:" tycho-0.<n>..tycho-0.<n+1> | grep -i also-by | sed -e 's/.*Also-[bB]y:\s*\(.*\)/\1/' | sort | uniq

1. 1. Announce the release on tycho-user@eclipse.org, tycho-dev@eclipse.org, thanking the contributors:

Subject: Tycho <n> released

Tycho <n> has been released and is available from maven central.

See the release notes [1] for details of enhancements and bug fixes in this release.

Thanks to 

<contributors>

who contributed patches for this release.

And thanks and to everyone who helped us with testing the staged version.

Regards,
Tycho team

[1] http://wiki.eclipse.org/Tycho/Release_Notes/<n>

1. 1. Optionally, announce on other medias (Twitter)