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 |
|||
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. | ||
− | + | # Make sure all bugs have the correct target milestone for this release | |
− | + | # Schedule a new release and generate the IP log on [https://projects.eclipse.org/projects/technology.tycho projects.eclipse.org] | |
− | + | # Prepare the [[Tycho/Release Notes]] which should provide a quick overview of new features and bug fixes | |
− | + | # Link the N&N to the [https://projects.eclipse.org/projects/technology.tycho release review] and send [mailto:technology-pmc@eclipse.org?subject=release%20review%20docs%20for%20Eclipse%20Tycho&body=Hi%20PMC%20members,%0A%0Aplease%20approve%20release%20review%20docs%20for%20Tycho%20VERSION%0A%0Ahttps://projects.eclipse.org/projects/technology.tycho/releases/VERSION%0A%0ABest%20Regards,%0ATycho%20team email to technology-pmc@eclipse.org] to review the release docs. *# # 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 <br/><tt>mvn org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=...</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 | |
− | + | # Create the new version and milestone in the [https://dev.eclipse.org/committers/bugs/bugz_manager.php bugzilla manager] | |
− | + | # 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><OSS_ID></tt> in <tt>~/.m2/settings.xml</tt> | |
− | + | # Checkout the tag versions for both <tt>tycho-<VERSION></tt> (and <tt>tycho-extras-<VERSION></tt> so current commit is the tag. | |
− | + | # 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: | |
− | + | <pre> | |
− | + | 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> | ||
+ | </pre> | ||
+ | # 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] | ||
+ | # ... Wait until review date (usually a week later)... | ||
+ | # 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: | ||
<pre> | <pre> | ||
git log --pretty=format:%an tycho-0.<n>..tycho-0.<n+1> | sort | uniq | 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 | 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> | </pre> | ||
− | + | # Announce the release on tycho-user@eclipse.org, tycho-dev@eclipse.org, thanking the contributors: | |
<pre> | <pre> | ||
Subject: Tycho <n> released | Subject: Tycho <n> released | ||
Line 47: | Line 67: | ||
[1] http://wiki.eclipse.org/Tycho/Release_Notes/<n> | [1] http://wiki.eclipse.org/Tycho/Release_Notes/<n> | ||
</pre> | </pre> | ||
− | + | # Update the [http://www.eclipse.org/tycho tycho homepage new and noteworthy section] | |
− | + | ||
− | + | ||
[[Category:Tycho]] | [[Category:Tycho]] |
Revision as of 11:50, 22 March 2019
This page describes the steps necessary to create releases of the Tycho project.
- Make sure all bugs have the correct target milestone for this release
- Schedule a new release and generate the IP log on projects.eclipse.org
- Prepare the Tycho/Release Notes which should provide a quick overview of new features and bug fixes
- Link the N&N to the release review and send email to technology-pmc@eclipse.org to review the release docs. *# # 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
- Create the new version and milestone in the bugzilla manager
- 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
- Checkout the tag versions for both tycho-<VERSION> (and tycho-extras-<VERSION> so current commit is the tag.
- 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
- ... Wait until review date (usually a week later)...
- 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