velocity-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cbris...@apache.org
Subject svn commit: r1871673 - in /velocity/site/cms/trunk/content: release-process.mdtext site-building.mdtext
Date Mon, 16 Dec 2019 18:22:45 GMT
Author: cbrisson
Date: Mon Dec 16 18:22:45 2019
New Revision: 1871673

URL: http://svn.apache.org/viewvc?rev=1871673&view=rev
Log:
[site] Little edits in general pages

Modified:
    velocity/site/cms/trunk/content/release-process.mdtext
    velocity/site/cms/trunk/content/site-building.mdtext

Modified: velocity/site/cms/trunk/content/release-process.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/release-process.mdtext?rev=1871673&r1=1871672&r2=1871673&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/release-process.mdtext (original)
+++ velocity/site/cms/trunk/content/release-process.mdtext Mon Dec 16 18:22:45 2019
@@ -73,18 +73,37 @@ These operations need to be performed on
 
 These steps must be performed **for each** release.
 
-* Check dependencies and velocity-parent versions
+* Check updates of dependencies and maven plugins:
+
+        :::shell
+        mvn versions:display-dependency-updates
+        mvn versions:display-plugin-updates
+
+* Check content of root README.md file (for new features documentation, important notices,
and stated dependencies versions).
+
+* Also check updates for the parent velocity-master artifact version.
 
 * Archive the previous release candidate
 
     If it's not the first release candidate you're trying to release, you should archive
the previous release candidate. For instance:
     
         :::shell
-        svn mv ci -m "[engine] archive engine 2.0 RC4" https://_your_apache_id_@svn.apache.org/repos/asf/velocity/engine/tags/2.0
https://_your_apache_id_@svn.apache.org/repos/asf/velocity/engine/tags/2.0-RC4
+        svn mv -m "[engine] archive engine 2.0 RC4" https://_your_apache_id_@svn.apache.org/repos/asf/velocity/engine/tags/2.0
https://_your_apache_id_@svn.apache.org/repos/asf/velocity/engine/tags/2.0-RC4
     
     And don't forget to also drop the staged artifact.
     
-    Of course, you will also have to revert the automated commits from the previous `mvn
release:*` commands.
+    Of course, you will also have to revert the automated commits from the previous `mvn
release:*` commands. You can use the following shell one-liner to get their revision numbers:
+    
+        :::shell
+        $ svn log pom.xml | grep -B2 maven-release-plugin | egrep "^r" | head -2 | cut -d'
' -f 1
+        r1866626
+        r1866624
+    
+    Then, revert:
+    
+        svn merge -r1866626:1866623 .
+        svn commit -m "[engine/tools] Revert poms for next 2.2 RC attempt"
+
 
 * Complete and update the changelog source file `src/changes/changes.xml` (note: we may get
rid of this changelog in the future since it is quite painful to maintain and seems highly
redundant with the JIRA release notes).
 
@@ -96,8 +115,8 @@ These steps must be performed **for each
         :::shell
         mvn release:prepare -Dusername=YOUR_SVN_USER -Dpassword=YOUR_SVN_PASSWORD
     
-    The plugin interactively will ask you the version to release, the Subversion tag to use
and the next snapshot version. Rather than `velocity-engine-parent-X.X` (the default), we
tend to use X.X for the tag name.
-    
+    The plugin will interactively ask you the version to release, the subversion tag to use
and the next snapshot version. Rather than the proposed default `velocity-engine-parent-X.X`,
we tend to use X.X for the subversion tag.
+
 * Perform the release
     
     To perform the release, i.e. creating and deploying Maven artifacts, use:
@@ -160,7 +179,7 @@ These steps must be performed **for each
 
 * Prepare the site
 
-    Copy the `/devel/` section to its `<version>` section (but do not yet refence it
from the menu)
+    Copy the `/devel/` section to its `<version>` section (but do not yet refence it
from the menu), and fix any SNAPSHOT link within.
     
     Generate the corresponding javadoc with
     

Modified: velocity/site/cms/trunk/content/site-building.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/site-building.mdtext?rev=1871673&r1=1871672&r2=1871673&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/site-building.mdtext (original)
+++ velocity/site/cms/trunk/content/site-building.mdtext Mon Dec 16 18:22:45 2019
@@ -71,6 +71,15 @@ Notes:
 
 ### Additional Notes
 
+### Javadocs
+
+For the time being, here are the steps to build the javadocs (listed for the engine, adapt
for the tools):
+
+1. issue an `mvn javadoc:aggregate -pl !velocity-custom-parser-example` command at the root
of the source tree (the `-pl` option is here to ignore a specific module from the docs)
+2. copy the content of the `target/site/apidocs` directory inside of the `apidocs` directory
of the apropriate module inside the site sources
+3. commit this result (which will produce a first big fat commit email...)
+3. generate the site then commit the production result (second horrible commit email...)
+
 #### Table of Content
 
 Per-page table of contents can be displayed with the following placeholder:



Mime
View raw message