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.
Difference between revisions of "Releasing Tycho"
m |
m |
||
(19 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. |
− | * Prepare the [[Tycho/Release Notes]] which should provide a quick overview of new features and bug fixes | + | *Prepare the [[Tycho/Release Notes]] which should provide a quick overview of new features and bug fixes |
− | * 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 | + | *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 <tt>mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=...</tt> | + | *Update versions using <br/><tt>mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=...</tt> |
− | * Commit version change, create a git tag <tt>tycho-<VERSION></tt> | + | *Commit version change, and create a git tag <tt>tycho-<VERSION></tt> (and <tt>tycho-extras-<VERSION></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 | + | *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 [ | + | *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 <OSS_ID> in ~/.m2/settings.xml | + | *Add your credentials for server <tt><OSS_ID></tt> in <tt>~/.m2/settings.xml</tt> |
− | * Sync to release commit and deploy to nexus staging repository: <tt>mvn clean deploy -Prelease -DforgeReleaseId=<OSS_ID> -DforgeReleaseUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/</tt> | + | *Sync to release commit and deploy to nexus staging repository: <br/><tt>mvn clean deploy -Prelease -DforgeReleaseId=<OSS_ID> -DforgeReleaseUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -Dgpg.passphrase=<YOUR_GPG_PASSPAHRASE></tt> |
− | * Close the staging repository and announce the temporary stage URL on tycho-user@eclipse.org | + | *Close the staging repository and announce the temporary stage URL on tycho-user@eclipse.org:<tt><br/>Subject: please test staged tycho <VERSION> <br/><br/>Tycho release <VERSION> has been staged. For details of new features and bugfixes, see release notes [1]. <br/> Please help by testing the staged build. To use it, change your tycho version to <VERSION> 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/<VERSION> <br/>[2]<br/><pluginRepositories><br/> <pluginRepository><br/> <id>tycho-staged</id><br/> <url><NEXUS_OSS_STAGING_URL></url><br/> </pluginRepository><br/></pluginRepositories><br/></tt> |
− | * Generate site docs 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] | + | *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] |
− | * Browse the [[:Category:Tycho|Tycho wiki pages]] to update any hardcoded tycho versions to the latest version | + | *After ~1 week of testing, promote the stage repository on https://oss.sonatype.org/ |
− | * Update [http://git.eclipse.org/c/tycho/org.eclipse.tycho-demo.git/ tycho-demo projects] to the latest release | + | ** Only drop the staging repository once the artifacts have reached Maven central. |
− | * Announce the release on tycho-user@eclipse.org, tycho-dev@eclipse.org and the [http://www.eclipse.org/tycho tycho homepage new and noteworthy section] | + | *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: | ||
+ | <pre> | ||
+ | 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 | ||
+ | </pre> | ||
+ | * Announce the release on tycho-user@eclipse.org, tycho-dev@eclipse.org, thanking the contributors: | ||
+ | <pre> | ||
+ | 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> | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | * Update the [http://www.eclipse.org/tycho tycho homepage new and noteworthy section] | ||
[[Category:Tycho]] | [[Category:Tycho]] |
Revision as of 10:19, 26 January 2018
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/ -Dgpg.passphrase=<YOUR_GPG_PASSPAHRASE> - 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> - 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 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
- 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>
- Update the tycho homepage new and noteworthy section