You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lens.apache.org by am...@apache.org on 2015/04/15 21:47:39 UTC
[15/30] incubator-lens git commit: LENS-10: Updates branching,
versioning and compatibility strategies (Amareshwari Sriramadasu via
prongs)
LENS-10: Updates branching, versioning and compatibility strategies (Amareshwari Sriramadasu via prongs)
Project: http://git-wip-us.apache.org/repos/asf/incubator-lens/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-lens/commit/534ef2f2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-lens/tree/534ef2f2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-lens/diff/534ef2f2
Branch: refs/heads/master
Commit: 534ef2f2e77170fd1583891c338dd95d92d7588a
Parents: 4639f6b
Author: Amareshwari Sriramadasu <am...@apache.org>
Authored: Tue Feb 17 15:17:17 2015 +0530
Committer: Amareshwari Sriramadasu <am...@apache.org>
Committed: Wed Feb 18 10:27:53 2015 +0530
----------------------------------------------------------------------
src/site/apt/developer/contribute.apt | 36 ++++++++++++++++++++++++++
src/site/apt/releases/incompatibility.apt | 18 -------------
src/site/apt/releases/release-note.apt | 18 -------------
src/site/site.xml | 4 +--
4 files changed, 38 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/534ef2f2/src/site/apt/developer/contribute.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/developer/contribute.apt b/src/site/apt/developer/contribute.apt
index 5eb5ff5..91e7b81 100644
--- a/src/site/apt/developer/contribute.apt
+++ b/src/site/apt/developer/contribute.apt
@@ -527,3 +527,39 @@ Developer Documentation : How to contribute to Apache Lens?
Run the command mvn apache-rat:check. If check needs to be excluded for any file, it should be put in excludes section
in parent project pom's apache-rat-plugin.
+
+** What is versioning strategy in Lens?
+
+ Lens follows three number versioning which is major.minor.revision. If the current release is 2.0.0, the next usual
+ development release will be 2.1.0. If there needs to be separate release on released version and not from development
+ branch (usually critical patch release), it will be 2.0.1. If the next release is not compatible with previous
+ release, then the major version needs to be incremented, then it would become 3.0.0. This way all 2.x.x releases will
+ be compatible with one another. And incompatibility is clearly communicated to users through major version number
+ change.
+
+ The jira fix version for all the issues in 2.0.x is called 2.0, and 2.1.x is called 2.1. For patch releases from
+ release branch, the jira fix version can be exact patch release version number.
+
+** What is the branching strategy in Lens?
+
+ Lens has two main branches - <<master>> and <<current-release-line>>. All the day to day development happens on
+ <<master>> branch. <<current-release-line>> branch is used to make releases. When <<master>> branch is ready for
+ release (all improvements/features/bug fixes marked for release are fixed and all tests passing), <<master>> will be
+ merged to <<current-release-line>>. The version number on <<master>> will be incremented to next development version.
+ The only issues that can be cherry-picked into <<current-release-line>> till release is rolled are
+ critical/blocker bugs, documentation changes and test case changes. Once all the issues are verified for the release,
+ and release will be triggered from <<current-release-line>>.
+
+ If a critical release (not pulling code from master) needs to be made, a new branch will be created with release
+ number, by checking out <<current-release-line>> branch. And changes will be put on the branch. Once the branch is
+ ready they will merged to <<current-release-line>> and released. The changes should be cherry-picked back into
+ <<master>> from <<current-release-line>> once the release is made and resolving conflicts in <<master>> if any.
+ Having two main branches makes all release tags to be created on <current-release-line> branch and removes the pile
+ up of old and stale branches, which are created by one for each release.
+
+ For major version increments, <<current-release-line>> will be branched to a a <$major.x-line> and
+ <<current-release-line>> and master will be moved to next major version.
+
+ There can be feature branches created from <<master>>, if feature is not actively developed in <<master>> branch
+ directly. For a feature branch to be created a contirbutor can start discuss thread on dev list for consensus on
+ whether it is required.
http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/534ef2f2/src/site/apt/releases/incompatibility.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/releases/incompatibility.apt b/src/site/apt/releases/incompatibility.apt
deleted file mode 100644
index 8a8293a..0000000
--- a/src/site/apt/releases/incompatibility.apt
+++ /dev/null
@@ -1,18 +0,0 @@
-~~
-~~ 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.
-~~
http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/534ef2f2/src/site/apt/releases/release-note.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/releases/release-note.apt b/src/site/apt/releases/release-note.apt
deleted file mode 100644
index 8a8293a..0000000
--- a/src/site/apt/releases/release-note.apt
+++ /dev/null
@@ -1,18 +0,0 @@
-~~
-~~ 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.
-~~
http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/534ef2f2/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index a134ff2..9faaa80 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -47,8 +47,8 @@
</menu>
<menu name="Releases" >
<item name="Download" href="./releases/download.html" />
- <item name="Compatibility" href="./releases/incompatibility.html" />
- <item name="Release Notes" href="./releases/release-note.html" />
+ <item name="Compatibility" href="./releases/compatibility.html" />
+ <item name="All Releases" href="./releases/release-history.html" />
</menu>
<menu name="User Documentation">
<item name="Lens User Guide" href="./user/index.html" />