svn commit: r1872817 - /jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/howto_release.md

[kw...@apache.org]

Author: kwin
Date: Wed Jan 15 15:59:32 2020
New Revision: 1872817

URL: http://svn.apache.org/viewvc?rev=1872817&view=rev
Log:
trivial: add steps on how to publish website with javadocs after a
release

Modified:
    jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/howto_release.md

Modified: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/howto_release.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/howto_release.md?rev=1872817&r1=1872816&r2=1872817&view=diff
==============================================================================
--- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/howto_release.md (original)
+++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/howto_release.md Wed Jan 15 15:59:32 2020
@@ -35,11 +35,11 @@ Release management tasks
 1. Make sure that an appropriate version for the release is entered in [Jira][3] and that all the related issues have
    been resolved.
    
-2. Create or update a `RELEASE-NOTES.txt` file in the root folder of the project to be released. When done, commit the
+1. Create or update a `RELEASE-NOTES.txt` file in the root folder of the project to be released. When done, commit the
    file. See previous release notes for examples of what to include. The release note report in [Jira][3] is a useful
    source of required information.
    
-3. Build and deploy the release artifacts with Maven (see below).
+1. Build and deploy the release artifacts with Maven (see below).
 
     The release is built using the Maven release plugin. See the [Releasing a Maven project][4] guide for more
     details. Make sure you have added the pgp key information in you maven settings file, especially if you have 
@@ -55,9 +55,9 @@ Release management tasks
 
         The non-Maven release artifacts are automatically copied to `/.../target/checkout/target/$version`
 
-4. Close the [staged repository][2] on <https://repository.apache.org>.
+1. Close the [staged repository][2] on <https://repository.apache.org>.
 
-5. Upload the artifacts to https://dist.apache.org/repos/dist/dev/jackrabbit/filevault via SVN
+1. Upload the artifacts to https://dist.apache.org/repos/dist/dev/jackrabbit/filevault via SVN
        
         svn co https://dist.apache.org/repos/dist/dev/jackrabbit/filevault dist-dev-filevault
         cd dist-dev-filevault
@@ -65,9 +65,9 @@ Release management tasks
         svn add $version
         svn commit -m "Apache Jackrabbit Filevault $version release candidate" $version
        
-6. Start the vote thread, wait **72 hours**. See the `vote.txt` template generated by the Maven build.
+1. Start the vote thread, wait **72 hours**. See the `vote.txt` template generated by the Maven build.
 
-7. If the vote fails (easy case first):
+1. If the vote fails (easy case first):
     1. remove the release tag from svn
 
        ````
@@ -78,9 +78,9 @@ Release management tasks
     3. and drop the [staged repository][2]
     4. done 
  
-8. If the vote is successful, close the vote by publishing the results
+1. If the vote is successful, close the vote by publishing the results
 
-9. copy the release candidate from `dev/jackrabbit` to `release/jackrabbit` in 
+1. copy the release candidate from `dev/jackrabbit` to `release/jackrabbit` in 
    <https://dist.apache.org/repos/dist/>, and delete any older releases from the same branch 
    (they're automatically archived):
 
@@ -90,23 +90,25 @@ Release management tasks
         https://dist.apache.org/repos/dist/release/jackrabbit/filevault/$version
     ````
 
-10. release the [staged repository][2] for synchronization to Maven central.
+1. release the [staged repository][2] for synchronization to Maven central.
 
-11. mark the version as released in [Jira][3]:
+1. update the website by first checking out the released tag, then execute `mvn clean site` on the reactor project (this will copy the aggregate javadoc to the `vault-doc/target` folder). Afterwards check the generated site and push it via `mvn site-deploy` (only relevant on module `vault-doc`)
+
+1. mark the version as released in [Jira][3]:
     _Jira Project Home_ -> _Project Summary_ -> _Administer Project_. 
         
     Under Versions, you'll see all the defined project versions. 
     From the settings menu, choose *Release* on the version.
 
-12. Close all the issues included in the release: 
+1. Close all the issues included in the release: 
     _Jira Project Home_ -> _Change Log_ -> Choose the released version. 
         
     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!
 
-13. Update the Jackrabbit web site to point to the new release.
+1. Update the Jackrabbit web site to point to the new release.
 
-14. Send the release announcement **once** the web site and download mirrors have been synced.
+1. Send the release announcement **once** the web site and download mirrors have been synced.
 
 
 Related Links