Author: davide
Date: Tue Jan 9 12:08:25 2018
New Revision: 1820646
URL: http://svn.apache.org/viewvc?rev=1820646&view=rev
Log:
docs around how to do branching
Added:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/branching.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/site.xml
Added: jackrabbit/oak/trunk/oak-doc/src/site/markdown/branching.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/branching.md?rev=1820646&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/branching.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/branching.md Tue Jan 9
12:08:25 2018
@@ -0,0 +1,62 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Branching
+
+Following a quick reminder on how to do branching for a stable release.
+
+It's based on the 1.8 branching, fix the commands where needed. For
+details about each option please refer to the
+[official
documentation](http://maven.apache.org/maven-release/maven-release-plugin/branch-mojo.html).
+
+## 1. Test the command locally
+
+ $ mvn release:branch -DbranchName=1.8 \
+ -DbranchBase=https://svn.apache.org/repos/asf/jackrabbit/oak/branches \
+ -DupdateBranchVersions=true -DreleaseVersion=1.8.0-SNAPSHOT \
+ -DdryRun=true
+
+You will be prompted for the next trunk version. In our example:
`1.10-SNAPSHOT`.
+
+Check that the following files contains the right versions
+
+ pom.xml.branch # should be 1.8.0-SNAPSHOT
+ pom.xml.next # should be 1.10-SNAPSHOT
+ pom.xml.releaseBackup # should be 1.8-SNAPSHOT
+
+## 2. Revert the local changes
+
+You'll have a bunch of files locally that are not committed to svn.
+Just to have a clean situation clean up everything
+
+ $ svn st | grep '^?' | awk '{print $2}' | xargs rm
+
+## 3. Actual branching
+
+Re-execute the first command **without** the `-DdryRun=true`
+
+ $ mvn release:branch -DbranchName=1.8 \
+ -DbranchBase=https://svn.apache.org/repos/asf/jackrabbit/oak/branches \
+ -DupdateBranchVersions=true -DreleaseVersion=1.8.0-SNAPSHOT \
+
+Now you can checkout the branch and proceed with the release as normal.
+
+## References
+
+- http://maven.apache.org/maven-release/maven-release-plugin/branch-mojo.html
+-
http://maven.apache.org/maven-release/maven-release-plugin/examples/branch.html
+- http://jackrabbit.apache.org/jcr/creating-releases.html
Modified: jackrabbit/oak/trunk/oak-doc/src/site/site.xml
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/site.xml?rev=1820646&r1=1820645&r2=1820646&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Tue Jan 9 12:08:25 2018
@@ -79,6 +79,7 @@ under the License.
<item href="participating.html" name="Participating" />
<item href="developing-with-git.html" name="Developing with Git" />
<item href="diagnostic-builds.html" name="Cutting diagnostic builds" />
+ <item href="branching.html" name="Branching off a new stable" />
<item href="attribution.html" name="Attribution" />
<item href="release-schedule.html" name="Release Schedule" />
</menu>
