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 2020/07/24 07:46:24 UTC
svn commit: r1880235 -
/jackrabbit/site/trunk/src/site/markdown/creating-releases.md
Author: reschke
Date: Fri Jul 24 07:46:24 2020
New Revision: 1880235
URL: http://svn.apache.org/viewvc?rev=1880235&view=rev
Log:
mention CI status
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=1880235&r1=1880234&r2=1880235&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/creating-releases.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/creating-releases.md Fri Jul 24 07:46:24 2020
@@ -56,16 +56,17 @@ Release management tasks
### Part I: up to the release vote
-1. Consider checking the CVE database for vulnerabilities in dependencies,
+1. Check the CI status of the project ([Jackrabbit Jenkins](https://ci-builds.apache.org/job/Jackrabbit/))
+2. Consider checking the CVE database for vulnerabilities in dependencies,
using `mvn org.owasp:dependency-check-maven:5.3.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
+3. 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))
and that all the related issues have been resolved.
-3. Create a new version in JIRA for the next release.
-4. Create a `RELEASE-NOTES.txt` file in the root folder of the project to be released.
+4. Create a new version in JIRA for the next release.
+5. Create a `RELEASE-NOTES.txt` file in the root folder of the project to be released.
If such a file already exists, update it for the release. See a previous
release notes for examples of what to include. The release note report in Jira is a
useful source of required information: Open the [Jackrabbit Jira](https://issues.apache.org/jira/projects/JCR?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page)
@@ -73,31 +74,31 @@ Release management tasks
click on the release, then on the "Release Notes" link on the top.
Double-check that all version numbers in the updated Release Notes are accurate.
When done, commit the file.
-5. If the branch is one that supports Java 8 or newer, make sure that the API docs can indeed be built with Java 8, using both `javadoc:javadoc` and `javadoc:aggregate`.
+6. If the branch is one that supports Java 8 or newer, make sure that the API docs can indeed be built with Java 8, using both `javadoc:javadoc` and `javadoc:aggregate`.
If the branch supports Java 11 or newer, repeat this with Java 11.
-6. Make sure that the build succeeds with all Java versions it is supposed to support (trying with the earliest and latest is ok).
-7. When releasing a Jackrabbit version that will be used in Oak, make sure it
+7. Make sure that the build succeeds with all Java versions it is supposed to support (trying with the earliest and latest is ok).
+8. When releasing a Jackrabbit version that will be used in Oak, make sure it
doesn't break Oak.
* Check by building the applicable Oak version using `mvn clean install -PintegrationTesting -Djackrabbit.version=2.x.y-SNAPSHOT`
* If the update does require changes in Oak, open JIRA tickets and link them to the JIRA tickets tracking the release activity.
-8. If this is a stable branch, review changes to export versions which should be avoided (see [OAK-6346](https://issues.apache.org/jira/browse/OAK-6346) for context). If there are indeed changes (as in the example below), see [Appendix E](#Appendix_E:_Version_Changes).
+9. If this is a stable branch, review changes to export versions which should be avoided (see [OAK-6346](https://issues.apache.org/jira/browse/OAK-6346) for context). If there are indeed changes (as in the example below), see [Appendix E](#Appendix_E:_Version_Changes).
# Oak 1.8 as of November 2018
svn diff https://svn.apache.org/repos/asf/jackrabbit/oak/tags/jackrabbit-oak-1.8.8 . | grep -i "@Version" -B 6
-@Version("1.5.0")
+@Version("1.6.0")
-9. On the other hand, if this is a release from trunk, carefully review all
- export versions and check that no change introduces new dependencies on
- Guava (see [OAK-7182](https://issues.apache.org/jira/browse/OAK-7182))
-10. If this is a release with Java 7 or older, make sure that your `MAVEN_OPTS` contain `-Dhttps.protocols=TLSv1.2`.
-11. When doing "stable" release (even-numbered), check that we do not have
- dependencies to unstable releases. In particular, stable releases of Oak
- should not reference unstable Jackrabbit releases (if this is the case,
- a new stable Jackrabbit release might be required in order to proceed).
-12. Build and deploy the release artifacts with Maven. See [below](#Steps_to_build_the_release_artifacts) for the exact steps.
-13. Do a sanity check that the [staged repository](https://repository.apache.org/index.html#stagingRepositories) on repository.apache.org contains all artifacts (~19 projects for Jackrabbit).
-14. Close the staged repository, giving it a meaningful name, such as "Apache Jackrabbit 2.x.y RC"
-15. Upload the artifacts to https://dist.apache.org/repos/dist/dev/jackrabbit/ as follows:
+10. On the other hand, if this is a release from trunk, carefully review all
+ export versions and check that no change introduces new dependencies on
+ Guava (see [OAK-7182](https://issues.apache.org/jira/browse/OAK-7182))
+11. If this is a release with Java 7 or older, make sure that your `MAVEN_OPTS` contain `-Dhttps.protocols=TLSv1.2`.
+12. When doing "stable" release (even-numbered), check that we do not have
+ dependencies to unstable releases. In particular, stable releases of Oak
+ should not reference unstable Jackrabbit releases (if this is the case,
+ a new stable Jackrabbit release might be required in order to proceed).
+13. Build and deploy the release artifacts with Maven. See [below](#Steps_to_build_the_release_artifacts) for the exact steps.
+14. Do a sanity check that the [staged repository](https://repository.apache.org/index.html#stagingRepositories) on repository.apache.org contains all artifacts (~19 projects for Jackrabbit).
+15. Close the staged repository, giving it a meaningful name, such as "Apache Jackrabbit 2.x.y RC"
+16. Upload the artifacts to https://dist.apache.org/repos/dist/dev/jackrabbit/ as follows:
# TARGET - where https://dist.apache.org/repos/dist/dev/jackrabbit/ is checked out
# SOURCE - where the release was built
@@ -116,11 +117,11 @@ Release management tasks
svn add oak/$version
svn commit -m "Apache Jackrabbit Oak $version release candidate" oak/$version
-16. Find the vote template (`./target/checkout/target/vote.txt`) generated by the Maven build and follow the instructions to verify the build yourself
-17. 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))
-18. Mark the version as released in Jira: [Jackrabbit Jira](https://issues.apache.org/jira/plugins/servlet/project-config/JCR/versions),
+17. Find the vote template (`./target/checkout/target/vote.txt`) generated by the Maven build and follow the instructions to verify the build yourself
+18. 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))
+19. 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.
-19. Wait 72 hours (we usually allow three business days, so be careful when a weekend is ahead)
+20. Wait 72 hours (we usually allow three business days, so be careful when a weekend is ahead)
### Part II: after the release vote