You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zookeeper.apache.org by an...@apache.org on 2018/10/15 14:48:47 UTC
[2/2] zookeeper git commit: ZOOKEEPER-3154: Update release process to
use the MarkDown solution
ZOOKEEPER-3154: Update release process to use the MarkDown solution
Added `mvn clean` and `mvn install` to `ant clean` and `ant compile` as dependency.
This way we clean and build zookeeper-docs maven sub-project when we clean and build main ant project.
Added releasenotes.md and fixed small issues in MarkDown files.
Next step is to remove not needed forrest content and dead ant code.
Only valid for branch-3.5, do not backport to branch-3.4.
Change-Id: I308a970c253be1bb82387516bf7b08bd7818a2c7
Author: Tamas Penzes <ta...@cloudera.com>
Reviewers: andor@apache.org
Closes #663 from tamaashu/ZOOKEEPER-3154-3.5 and squashes the following commits:
fce1499b [Tamas Penzes] ZOOKEEPER-3154: Removed HTML document generation which will be put back when maven migration will be done
06cba415 [Tamas Penzes] ZOOKEEPER-3154: Update release process to use the MarkDown solution
Project: http://git-wip-us.apache.org/repos/asf/zookeeper/repo
Commit: http://git-wip-us.apache.org/repos/asf/zookeeper/commit/000317fb
Tree: http://git-wip-us.apache.org/repos/asf/zookeeper/tree/000317fb
Diff: http://git-wip-us.apache.org/repos/asf/zookeeper/diff/000317fb
Branch: refs/heads/branch-3.5
Commit: 000317fb50daae81bc0b34fef5d2895b6aa851bd
Parents: ea1884e
Author: Tamas Penzes <ta...@cloudera.com>
Authored: Mon Oct 15 16:48:42 2018 +0200
Committer: Andor Molnar <an...@apache.org>
Committed: Mon Oct 15 16:48:42 2018 +0200
----------------------------------------------------------------------
build.xml | 13 +-
pom.xml | 2 +-
zookeeper-docs/pom.xml | 4 +-
.../src/main/resources/markdown/index.md | 2 +-
.../src/main/resources/markdown/javaExample.md | 2 +-
.../src/main/resources/markdown/recipes.md | 4 +-
.../src/main/resources/markdown/releasenotes.md | 1025 ++++++++++++++++++
7 files changed, 1041 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/000317fb/build.xml
----------------------------------------------------------------------
diff --git a/build.xml b/build.xml
index 5fd7037..72b234e 100644
--- a/build.xml
+++ b/build.xml
@@ -505,6 +505,7 @@ xmlns:cs="antlib:com.puppycrawl.tools.checkstyle.ant">
pattern="${ivy.lib}/[artifact]-[revision].[ext]"/>
<ivy:cachepath pathid="mvn-ant-task-classpath" conf="mvn-ant-task"/>
</target>
+
<target name="compile" depends="ivy-retrieve,clover,build-generated">
<javac destdir="${build.classes}" includeantruntime="false"
target="${javac.target}" source="${javac.source}" debug="on" encoding="${build.encoding}">
@@ -906,8 +907,10 @@ xmlns:cs="antlib:com.puppycrawl.tools.checkstyle.ant">
</copy>
<copy todir="${dist.dir}/docs">
- <fileset dir="${docs.dir}" />
- <fileset dir="${build.docs}"/>
+ <fileset dir="zookeeper-docs/src/main/resources/markdown/" includes="**">
+ <exclude name="html/**" />
+ </fileset>
+ <fileset dir="${build.docs}"/>
</copy>
<copy todir="${dist.dir}">
@@ -1031,8 +1034,10 @@ xmlns:cs="antlib:com.puppycrawl.tools.checkstyle.ant">
</copy>
<copy todir="${dist.dir}/docs">
- <fileset dir="${docs.dir}" />
- <fileset dir="${build.docs}"/>
+ <fileset dir="zookeeper-docs/src/main/resources/markdown/" includes="**">
+ <exclude name="html/**" />
+ </fileset>
+ <fileset dir="${build.docs}" />
</copy>
<copy todir="${dist.dir}">
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/000317fb/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index e07d730..dc4fb61 100755
--- a/pom.xml
+++ b/pom.xml
@@ -30,7 +30,7 @@
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
<packaging>pom</packaging>
- <version>2.6.0-SNAPSHOT</version>
+ <version>3.5.5-beta-SNAPSHOT</version>
<name>Apache ZooKeeper</name>
<description>
ZooKeeper is a centralized service for maintaining configuration information, naming,
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/000317fb/zookeeper-docs/pom.xml
----------------------------------------------------------------------
diff --git a/zookeeper-docs/pom.xml b/zookeeper-docs/pom.xml
index b075f97..808e2f6 100644
--- a/zookeeper-docs/pom.xml
+++ b/zookeeper-docs/pom.xml
@@ -25,13 +25,13 @@
<parent>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
- <version>2.6.0-SNAPSHOT</version>
+ <version>3.5.5-beta-SNAPSHOT</version>
<relativePath>..</relativePath>
</parent>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper-docs</artifactId>
- <version>2.6.0-SNAPSHOT</version>
+ <version>3.5.5-beta-SNAPSHOT</version>
<name>Apache ZooKeeper - Documentation</name>
<description>Documentation</description>
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/000317fb/zookeeper-docs/src/main/resources/markdown/index.md
----------------------------------------------------------------------
diff --git a/zookeeper-docs/src/main/resources/markdown/index.md b/zookeeper-docs/src/main/resources/markdown/index.md
index 6425784..081cfc8 100644
--- a/zookeeper-docs/src/main/resources/markdown/index.md
+++ b/zookeeper-docs/src/main/resources/markdown/index.md
@@ -36,7 +36,7 @@ archives.
+ [Release Notes](releasenotes.html) - new developer and user facing features, improvements, and incompatibilities
+ **Developers**
Documents for Developers using the ZooKeeper Client API
- + [API Docs](index.html) - the technical reference to ZooKeeper Client APIs
+ + [API Docs](api/index.html) - the technical reference to ZooKeeper Client APIs
+ [Programmer's Guide](zookeeperProgrammers.html) - a client application developer's guide to ZooKeeper
+ [ZooKeeper Java Example](javaExample.html) - a simple Zookeeper client appplication, written in Java
+ [Barrier and Queue Tutorial](zookeeperTutorial.html) - sample implementations of barriers and queues
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/000317fb/zookeeper-docs/src/main/resources/markdown/javaExample.md
----------------------------------------------------------------------
diff --git a/zookeeper-docs/src/main/resources/markdown/javaExample.md b/zookeeper-docs/src/main/resources/markdown/javaExample.md
index b33963c..536b520 100644
--- a/zookeeper-docs/src/main/resources/markdown/javaExample.md
+++ b/zookeeper-docs/src/main/resources/markdown/javaExample.md
@@ -237,7 +237,7 @@ sets a watch, and passes a reference to itself (`this`)
as the completion callback object. In this sense, it kicks things off, since the
real processing happens when the watch is triggered.
-######Note
+###### Note
>Don't confuse the completion callback with the watch callback. The `ZooKeeper.exists()`
completion callback, which happens to be the method `StatCallback.processResult()` implemented
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/000317fb/zookeeper-docs/src/main/resources/markdown/recipes.md
----------------------------------------------------------------------
diff --git a/zookeeper-docs/src/main/resources/markdown/recipes.md b/zookeeper-docs/src/main/resources/markdown/recipes.md
index 4312430..0b8df89 100644
--- a/zookeeper-docs/src/main/resources/markdown/recipes.md
+++ b/zookeeper-docs/src/main/resources/markdown/recipes.md
@@ -181,7 +181,7 @@ the list obtained from the first **getChildren(
)** call. If there are are no children in the queue node, the
reader waits for a watch notification to check the queue again.
-######Note
+###### Note
>There now exists a Queue implementation in ZooKeeper
recipes directory. This is distributed with the release --
zookeeper-recipes/zookeeper-recipes-queue directory of the release artifact.
@@ -208,7 +208,7 @@ any snapshot in time no two clients think they hold the same lock. These
can be implemented using ZooKeeeper. As with priority queues, first define
a lock node.
-######Note
+###### Note
>There now exists a Lock implementation in ZooKeeper
recipes directory. This is distributed with the release --
zookeeper-recipes/zookeeper-recipes-lock directory of the release artifact.