Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Releasing Tycho"

(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page describes the steps necessary to create releases of the Tycho project.
+
This page describes the steps necessary to create releases of the Tycho project.  
  
* TODO
+
*Prepare the [[Tycho/Release Notes]] which should provide a quick overview of new features and bug fixes
* Edit the list of releases on [http://www.eclipse.org/projects/project.php?id=technology.tycho Tycho project page] via the [https://dev.eclipse.org/portal/myfoundation/portal/portal.php Eclipse portal]
+
*Steps below apply to both [http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/ tycho] and [http://git.eclipse.org/c/tycho/org.eclipse.tycho.extras.git/ tycho-extras] git repositories as these should normally be released together and with the same version
 +
*Update versions using <br/><tt>mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=...</tt>
 +
*Commit version change, and create a git tag <tt>tycho-&lt;VERSION&gt;</tt> (and <tt>tycho-extras-&lt;VERSION&gt;</tt> respectively) on this commit 
 +
*Update versions (same as above) to next <tt>-SNAPSHOT</tt> development version and push commit to <tt>master</tt> branch
 +
*Make sure you have everything setup (GPG installed!) for deploying to the Nexus OSS repository, see [https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide guide]
 +
*Add your credentials for server <tt>&lt;OSS_ID&gt;</tt> in <tt>~/.m2/settings.xml</tt>
 +
*Sync to release commit and deploy to nexus staging repository: <br/><tt>mvn clean deploy -Prelease -DforgeReleaseId=&lt;OSS_ID&gt; -DforgeReleaseUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/</tt>
 +
*Close the staging repository and announce the temporary stage URL on tycho-user@eclipse.org:<tt><br/>Subject:&nbsp;please test staged tycho &lt;VERSION&gt; <br/><br/>Tycho milestone release &lt;VERSION&gt; has been staged. For details of new features and bugfixes, see release notes [1]. <br/> Please help by testing the staged milestone build. To use it, change your tycho version to &lt;VERSION&gt; and add snippet [2] to your pom. <br/><br/> We plan to promote this release in one week unless major regressions are found.<br/><br/>Regards,<br/>  Tycho team<br/> <br/>  [1] http://wiki.eclipse.org/Tycho/Release_Notes/&lt;VERSION&gt; <br/>[2]<br/>&lt;pluginRepositories&gt;<br/>  &nbsp;&lt;pluginRepository&gt;<br/>    &nbsp;&nbsp;&lt;id&gt;tycho-staged&lt;/id&gt;<br/> &nbsp;&nbsp;&lt;url&gt;&lt;NEXUS_OSS_STAGING_URL&gt;&lt;/url&gt;<br/>  &nbsp;&lt;/pluginRepository&gt;<br/>&lt;/pluginRepositories&gt;<br/></tt>
 +
*Generate site docs for both tycho and tycho-extras using <tt>mvn clean install site site:stage</tt> and check the result in to [http://www.eclipse.org/tycho/sitedocs tycho homepage site docs]
 +
*After ~1 week of testing, promote the stage repository on https://oss.sonatype.org/
 +
** Only drop the staging repository once the artifacts have reached Maven central.
 +
*Push the release tags to git: <tt>git push origin --tags</tt>
 +
*Browse the [[:Category:Tycho|Tycho wiki pages]] to update any hardcoded tycho versions to the latest version
 +
*Update [http://git.eclipse.org/c/tycho/org.eclipse.tycho-demo.git/ tycho-demo projects] to the latest release
 +
 
 +
* Find out who contributed to the release: <tt>git log --pretty=format:%an tycho-0.<n>..tycho-0.<n+1> | sort | uniq</tt>
 +
* Announce the release on tycho-user@eclipse.org, tycho-dev@eclipse.org, thanking the contributors:
 +
 
 +
Subject: Tycho milestone <n> released
 +
 
 +
Tycho milestone <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>
 +
 
 +
 
 +
* Update the [http://www.eclipse.org/tycho tycho homepage new and noteworthy section]
  
 
[[Category:Tycho]]
 
[[Category:Tycho]]

Revision as of 07:06, 23 July 2014

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

  • Prepare the Tycho/Release Notes which should provide a quick overview of new features and bug fixes
  • Steps below apply to both tycho and tycho-extras git repositories as these should normally be released together and with the same version
  • Update versions using
    mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=...
  • Commit version change, and create a git tag tycho-<VERSION> (and tycho-extras-<VERSION> respectively) on this commit
  • Update versions (same as above) to next -SNAPSHOT development version and push commit to master branch
  • Make sure you have everything setup (GPG installed!) for deploying to the Nexus OSS repository, see guide
  • Add your credentials for server <OSS_ID> in ~/.m2/settings.xml
  • Sync to release commit and deploy to nexus staging repository:
    mvn clean deploy -Prelease -DforgeReleaseId=<OSS_ID> -DforgeReleaseUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/
  • Close the staging repository and announce the temporary stage URL on tycho-user@eclipse.org:
    Subject: please test staged tycho <VERSION>

    Tycho milestone release <VERSION> has been staged. For details of new features and bugfixes, see release notes [1].
    Please help by testing the staged milestone 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>
  • Generate site docs for both tycho and tycho-extras using mvn clean install site site:stage and check the result in to tycho homepage site docs
  • After ~1 week of testing, promote the stage repository on https://oss.sonatype.org/
    • Only drop the staging repository once the artifacts have reached Maven central.
  • Push the release tags to git: git push origin --tags
  • Browse the Tycho wiki pages to update any hardcoded tycho versions to the latest version
  • Update tycho-demo projects to the latest release
  • Find out who contributed to the release: git log --pretty=format:%an tycho-0.<n>..tycho-0.<n+1> | sort | uniq
  • Announce the release on tycho-user@eclipse.org, tycho-dev@eclipse.org, thanking the contributors:

Subject: Tycho milestone <n> released

Tycho milestone <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>


Back to the top