You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/11/16 20:34:50 UTC
[1/4] incubator-tinkerpop git commit: Update notes on branching in
git in the dev docs.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master 345efe220 -> e7783f934
Update notes on branching in git in the dev docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/445898a6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/445898a6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/445898a6
Branch: refs/heads/master
Commit: 445898a63848bda4748720a8d88891665410768b
Parents: 345efe2
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Nov 16 14:08:53 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Nov 16 14:08:53 2015 -0500
----------------------------------------------------------------------
docs/src/developer-contributing.asciidoc | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/445898a6/docs/src/developer-contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/developer-contributing.asciidoc b/docs/src/developer-contributing.asciidoc
index 01ee112..38da30d 100644
--- a/docs/src/developer-contributing.asciidoc
+++ b/docs/src/developer-contributing.asciidoc
@@ -147,15 +147,14 @@ distinguished from other changes in the release notes.
Branches
~~~~~~~~
-The "master" branch is used for the main line of development and release branches are constructed
-for ongoing maintenance work. For example, the "tp30" branch is used to maintain the 3.0.x line
-while work on 3.1.x proceeds on "master".
-
-Other branches may be created for collaborating on features or for RFC's that
-other developers may want to inspect. It is suggested that the JIRA issue ID be
-used as the prefix, since that triggers certain automation, and it provides a
-way to account for the branch lifecycle, i.e. "Who's branch is this, and can I
-delete it?"
+The "master" branch is used for the main line of development and release branches are constructed as needed
+for ongoing maintenance work. If new to the project or are returning to it after some time away, it may be good
+to send an email to the developer mailing list (or ask on HipChat) to find out what the current operating branches
+are.
+
+Other branches may be created for collaborating on features or for RFC's that other developers may want to inspect.
+It is suggested that the JIRA issue ID be used as the prefix, since that triggers certain automation, and it provides a
+way to account for the branch lifecycle, i.e. "Who's branch is this, and can I delete it?"
For branches that are NOT associated with JIRA issues, developers should utilize their Apache ID as
a branch name prefix. This provides a unique namespace, and also a way to account for the branch lifecycle.
[4/4] incubator-tinkerpop git commit: Improve/streamline released
docs based on 3.1.0-incubating release work.
Posted by sp...@apache.org.
Improve/streamline released docs based on 3.1.0-incubating release work.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/e7783f93
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/e7783f93
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/e7783f93
Branch: refs/heads/master
Commit: e7783f934efd4c08adc6362c953eb1ba101d8d4d
Parents: b2e516f
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Nov 16 14:30:42 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Nov 16 14:30:42 2015 -0500
----------------------------------------------------------------------
docs/src/developer-release.asciidoc | 31 +++++++++++++++++++------------
1 file changed, 19 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/e7783f93/docs/src/developer-release.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/developer-release.asciidoc b/docs/src/developer-release.asciidoc
index 6d53a00..a5ddcc8 100644
--- a/docs/src/developer-release.asciidoc
+++ b/docs/src/developer-release.asciidoc
@@ -51,6 +51,9 @@ during this period.
.. Deploy a final SNAPSHOT to the snapshot repository.
.. Review LICENSE and NOTICE files to make sure that no <<dependencies,changes are needed>>.
.. Review javadoc filters on the "Core API" docs to be sure nothing needs to change.
+.. Review JIRA tickets in the release and ensure that:
+... All tickets categorized by having a "Component" assigned.
+... All tickets are either of type "Bug" or "Enhancement".
. When all documentation changes are in place, use `bin/publish-docs.sh` to deploy a final `SNAPSHOT` representation
of the docs and thus validate that there are no issues with the documentation generation process. Request review
of the published documentation on the dev mailing list.
@@ -81,15 +84,19 @@ PMC Vote
A positive vote for a particular release from the TinkerPop PMC is required to move to the following phase.
-. `mvn clean install`
-.. `mvn verify -DskipIntegrationTests=false -DincludeNeo4j`
-.. `mvn verify -DskipPerformanceTests=false`
-. Perform manual tests:
-.. Execute `:remote connect conf/remote.yaml` and send some requests to a running Gremlin Server instance.
-.. Execute `:?` to display the help in the Console.
+. By this point, the testing performed during the code freeze should have validated the release. If however there
+are additional tests to perform that the release manager feels are relevant, they should be performed now. In other
+words, there is no need to rebuild the `SNAPSHOT` yet another time unless there are circumstances that would call its
+validity into question.
. Update `CHANGELOG.asciidoc`:
.. Update the release date
-.. Generate the JIRA release notes report for the current version and append them to the `CHANGELOG.asciidoc`
+.. Generate the JIRA release notes report for the current version and append them to the `CHANGELOG.asciidoc`.
+... Use an "advanced" search to filter out JIRA issues already released on other versions. For example: `fixVersion
+= 3.1.0-incubating AND fixVersion not in (3.0.2-incubating, 3.0.1-incubating`.
+... Consider use of an "Excel" export to organize, sort and prepare the JIRA tickets to be pasted to `CHANGELOG.asciidoc`
+... Be sure to include a link to other versions in the `CHANGELOG.asciidoc` that were previously released while the
+current release was under development as this new release will have those changes included within it. Please see
+3.1.0-incubating for an example.
.. Organize "breaking" changes to be clearly marked (use JIRA and the "breaking" label to identify those)
. Update "upgrade documentation":
.. Update the release date.
@@ -97,11 +104,11 @@ A positive vote for a particular release from the TinkerPop PMC is required to m
. `mvn versions:set -DnewVersion=x.y.z -DgenerateBackupPoms=false` to update project files to reference the non-SNAPSHOT version
. `git diff` and review the updated files (expect all `pom.xml` files and this README)
. `git commit -a -m "TinkerPop x.y.z release"` and `git push`
-. `git tag -a -m "TinkerPop x.y.z release" x.y.z` and `git push --tags`
. `mvn clean install -Dmaven.test.skip=true` - need to build first so that the right version of the console is used with `bin/publish-docs.sh`
-. `bin/publish-docs.sh <username>`
-. `mvn install -Papache-release -Djavadoc -DcreateChecksum=true -Dmaven.test.skip=true`
-. `mvn deploy -Papache-release -DcreateChecksum=true -Dmaven.test.skip=true`- deploy signed artifacts with checksums to link:https://repository.apache.org/[Apache Nexus]. Review (artifacts versions, file sizes, anything that might be out of place - request another committer to review as well) but do NOT close/release the staging repository at this time.
+. `bin/process-docs.sh` and validate the generated documentation locally
+. `bin/publish-docs.sh <username>` - Note that this step requires no additional processing as the previous step.
+handled document generation and this step now merely needs to upload what was generated.
+. `mvn deploy -Papache-release -DcreateChecksum=true -Dmaven.test.skip=true` - deploy signed artifacts with checksums to link:https://repository.apache.org/[Apache Nexus]. Review (artifacts versions, file sizes, anything that might be out of place - request another committer to review as well) but do NOT close/release the staging repository at this time.
. Review generated artifacts to be sure they have both javadocs and asciidocs present
. Upload artifacts to `https://dist.apache.org/repos/dist/dev/incubator/tinkerpop` for `[VOTE]` review.
.. `svn co --depth empty https://dist.apache.org/repos/dist/dev/incubator/tinkerpop/ dev` and `mkdir dev/x.y.z`
@@ -112,10 +119,10 @@ A positive vote for a particular release from the TinkerPop PMC is required to m
.. pass:[<code>ls * | xargs -n1 -I {} echo "mv apache-{} {}" | sed -e 's/distribution/bin/' -e 's/source-release/src/' -e s'/^\(.*\) \(.*\) \(.*\)$/\1 \3 \2/' | /bin/bash</code>]
.. `cd ..; svn add x.y.z/; svn ci -m "TinkerPop x.y.z release"`
. Execute `bin/validate-distribution.sh` and any other relevant testing.
+. `git tag -a -m "TinkerPop x.y.z release" x.y.z` and `git push --tags`
. Perform JIRA administration tasks:
.. "Release" the current version and set the "release date"
.. If there is to be a follow on release in the current line of code, create that new version specifying the "start date"
-.. Migrate the "Affected Version" of all unresolved issues to the next lowest common denominator version - if version 3.0.1 released then all 3.0.0 issues should move forward to 3.0.1 as they now "affect" that latest release
. Submit for `[VOTE]` at `dev@tinkerpop.incubator.apache.org` (see email template below)
. *Wait for vote acceptance* (72 hours)
[2/4] incubator-tinkerpop git commit: Corrected filenames in VOTE
template in release docs.
Posted by sp...@apache.org.
Corrected filenames in VOTE template in release docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/bd8ec084
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/bd8ec084
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/bd8ec084
Branch: refs/heads/master
Commit: bd8ec0846f1ce22b336b9a9415fc41639b54e602
Parents: 445898a
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Nov 16 14:10:55 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Nov 16 14:10:55 2015 -0500
----------------------------------------------------------------------
docs/src/developer-release.asciidoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bd8ec084/docs/src/developer-release.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/developer-release.asciidoc b/docs/src/developer-release.asciidoc
index c29da59..39a5f14 100644
--- a/docs/src/developer-release.asciidoc
+++ b/docs/src/developer-release.asciidoc
@@ -145,11 +145,11 @@ The release artifacts can be found at this location:
https://dist.apache.org/repos/dist/dev/incubator/tinkerpop/x.y.z/
The source distribution is provided by:
- apache-tinkerpop-x.y.z-source-release.zip
+ apache-tinkerpop-x.y.z-src.zip
Two binary distributions are provided for user convenience:
- apache-gremlin-console-x.y.z-distribution.zip
- apache-gremlin-server-x.y.z-distribution.zip
+ apache-gremlin-console-x.y.z-bin.zip
+ apache-gremlin-server-x.y.z-bin.zip
The online docs can be found here:
http://tinkerpop.incubator.apache.org/docs/x.y.z/ (user docs)
[3/4] incubator-tinkerpop git commit: Add a note about using the
currently generated release docs.
Posted by sp...@apache.org.
Add a note about using the currently generated release docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/b2e516f3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/b2e516f3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/b2e516f3
Branch: refs/heads/master
Commit: b2e516f3e0e5381783804dd9c886a8066e63e46c
Parents: bd8ec08
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Nov 16 14:13:36 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Nov 16 14:13:36 2015 -0500
----------------------------------------------------------------------
docs/src/developer-release.asciidoc | 5 +++++
1 file changed, 5 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/b2e516f3/docs/src/developer-release.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/developer-release.asciidoc b/docs/src/developer-release.asciidoc
index 39a5f14..6d53a00 100644
--- a/docs/src/developer-release.asciidoc
+++ b/docs/src/developer-release.asciidoc
@@ -28,6 +28,11 @@ feedback. Once a release point has been identified, the following phases repres
* Submit the official release for Incubator vote.
* Release and promote.
+NOTE: It might be helpful to use this document as generated from the currently release as opposed to one generate
+from a previous version or from recent `SNAPSHOT`. When using one generated for release, all the "versions" in the
+commands end up being set to the version that is being released, making cut and paste of those commands less labor
+intensive and error prone.
+
Pre-flight Check
----------------