You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by re...@apache.org on 2018/02/01 12:51:45 UTC
svn commit: r1822873 -
/jackrabbit/site/trunk/src/site/markdown/creating-releases.md
Author: reschke
Date: Thu Feb 1 12:51:45 2018
New Revision: 1822873
URL: http://svn.apache.org/viewvc?rev=1822873&view=rev
Log:
release instructions: split into two parts (up to the vote, after the vote)
Modified:
jackrabbit/site/trunk/src/site/markdown/creating-releases.md
Modified: jackrabbit/site/trunk/src/site/markdown/creating-releases.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/creating-releases.md?rev=1822873&r1=1822872&r2=1822873&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/creating-releases.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/creating-releases.md Thu Feb 1 12:51:45 2018
@@ -53,7 +53,13 @@ See [Appendix B](#Appendix_B:_Maven_sett
Release management tasks
------------------------
-1. When releasing from trunk, consider checking the CVE database for vulnerabilities in dependencies, using `mvn org.owasp:dependency-check-maven:3.0.2:aggregate` (first run will be slow because CVE databases are downloaded and parsed). If dependencies need action, open tickets and make sure they are marked as candidate backports where applicable.
+
+### Part I: up to the release vote
+
+1. When releasing from trunk, consider checking the CVE database for vulnerabilities in dependencies,
+ using `mvn org.owasp:dependency-check-maven:3.0.2:aggregate` (first run will be slow because CVE
+ databases are downloaded and parsed). If dependencies need action, open tickets and make sure they
+ are marked as candidate backports where applicable.
2. Make sure that an appropriate version for the release is entered in Jira
([Jackrabbit Jira](https://issues.apache.org/jira/projects/JCR?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page),
[Oak Jira](https://issues.apache.org/jira/projects/OAK?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page))
@@ -92,11 +98,14 @@ Release management tasks
9. Find the vote template (`vote.txt`) generated by the Maven build and follow the instructions to verify the build yourself
10. Start the vote thread by emailing the applicable mailing list ([Jackrabbit](mailto:dev@jackrabbit.apache.org?subject=%5BVOTE%5D%20Release%20Apache%20Jackrabbit%20x.y.z), [Oak](mailto:oak-dev@jackrabbit.apache.org?subject=%5BVOTE%5D%20Release%20Apache%20Jackrabbit%20Oak%20x.y.z))
-11. Wait 72 hours (we usually allow three business days, so be careful when a weekend is ahead)
-12. Mark the version as released in Jira: [Jackrabbit Jira](https://issues.apache.org/jira/plugins/servlet/project-config/JCR/versions),
+11. Mark the version as released in Jira: [Jackrabbit Jira](https://issues.apache.org/jira/plugins/servlet/project-config/JCR/versions),
[Oak Jira](https://issues.apache.org/jira/plugins/servlet/project-config/OAK/versions). You'll see all the defined project versions. From the settings menu, choose 'Release' on the version.
-13. If the vote fails (easy case first) remove the tag from svn, drop the staged repository and revert the version release in Jira - done
-14. If the vote is successful
+12. Wait 72 hours (we usually allow three business days, so be careful when a weekend is ahead)
+
+### Part II: after the release vote
+
+1. If the vote fails (easy case first) remove the tag from svn, drop the staged repository and revert the version release in Jira - done
+2. If the vote is successful
* close the vote by publishing the results
* copy the release candidate from dev/jackrabbit to release/jackrabbit in https://dist.apache.org/repos/dist/ -- **be careful to properly set the version variable!!!**
@@ -108,13 +117,12 @@ Release management tasks
* release the [staged repository](https://repository.apache.org/index.html#stagingRepositories) for synchronization to Maven central.
* make sure the previous step actually succeeded (we have seen a case where it failed and a retry was needed)
* close all the issues included in the release: [Jackrabbit Jira](https://issues.apache.org/jira/projects/JCR?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released) or [Oak Jira](https://issues.apache.org/jira/projects/OAK?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released) -> Choose the released version -> select "View in Issue Navigator". From the issue list you have the option to bulk update all of the included issues. Just 'Transition Issues' from 'Resolved' to 'Closed' and you are done!
-
-15. Update the Jackrabbit web site to point to the new release ([SVN](https://svn.apache.org/repos/asf/jackrabbit/site/trunk/)).
+3. Update the Jackrabbit web site to point to the new release ([SVN](https://svn.apache.org/repos/asf/jackrabbit/site/trunk/)).
1. add an entry to `index.md`
2. Update `downloads.md` (see [below](#Creating_Markdown_for_Downloads_Page)) - while doing so please a) remove obsoleted entries, and b) move new entries for Jackrabbit and/or Oak to the top)
-16. Send a release announcement to the [applicable mailing lists](mailto:announce@apache.org,announce@jackrabbit.apache.org,users@jackrabbit.apache.org,dev@jackrabbit.apache.org,oak-dev@jackrabbit.apache.org?subject=%5BANNOUNCE%5D%20Apache%20Jackrabbit%20...%20released) once the web site and download mirrors have been synced (see [example](http://mail-archives.apache.org/mod_mbox/jackrabbit-announce/201712.mbox/%3C894e13d2-9e20-1819-4741-b09ed040be09%40apache.org%3E)). Please note the announce mails needs to be sent from an @apache.org address.
-17. If the release was a Jackrabbit release used in Oak, make sure to also update the dependency in oak-parent/pom.xml (example: [OAK-4743](https://issues.apache.org/jira/browse/OAK-4743) - the current mapping is Jackrabbit 2.17 -> Oak trunk, Jackrabbit 2.16 -> Oak 1.8, Jackrabbit 2.14 -> Oak 1.6, Jackrabbit 2.12 -> Oak 1.4 and 1.2, Jackrabbit 2.8 -> Oak 1.0)
-18. If the release was a stable release for which we publish API docs (such as Jackrabbit), consider updating the live site (https://svn.apache.org/repos/asf/jackrabbit/site/live/ - when producing the API docs, use a checkout of the actual release, specify an English locale (-Dlocale=en) and try to pick the right JDK version to minimize changes over the previously checked in docs).
+4. Send a release announcement to the [applicable mailing lists](mailto:announce@apache.org,announce@jackrabbit.apache.org,users@jackrabbit.apache.org,dev@jackrabbit.apache.org,oak-dev@jackrabbit.apache.org?subject=%5BANNOUNCE%5D%20Apache%20Jackrabbit%20...%20released) once the web site and download mirrors have been synced (see [example](http://mail-archives.apache.org/mod_mbox/jackrabbit-announce/201712.mbox/%3C894e13d2-9e20-1819-4741-b09ed040be09%40apache.org%3E)). Please note the announce mails needs to be sent from an @apache.org address.
+5. If the release was a Jackrabbit release used in Oak, make sure to also update the dependency in oak-parent/pom.xml (example: [OAK-4743](https://issues.apache.org/jira/browse/OAK-4743) - the current mapping is Jackrabbit 2.17 -> Oak trunk, Jackrabbit 2.16 -> Oak 1.8, Jackrabbit 2.14 -> Oak 1.6, Jackrabbit 2.12 -> Oak 1.4 and 1.2, Jackrabbit 2.8 -> Oak 1.0)
+6. If the release was a stable release for which we publish API docs (such as Jackrabbit), consider updating the live site (https://svn.apache.org/repos/asf/jackrabbit/site/live/ - when producing the API docs, use a checkout of the actual release, specify an English locale (-Dlocale=en) and try to pick the right JDK version to minimize changes over the previously checked in docs).
Steps to build the release artifacts