This is an automated email from the ASF dual-hosted git repository.
andor pushed a commit to branch branch-3.5.5
in repository https://gitbox.apache.org/repos/asf/zookeeper.git
The following commit(s) were added to refs/heads/branch-3.5.5 by this push:
new 9872e7e ZOOKEEPER-3369: 3.5 - Maven release artifacts cleanup
9872e7e is described below
commit 9872e7efe7b1cad61b8db16382260dda1f63e40e
Author: Norbert Kalmar <[email protected]>
AuthorDate: Thu Apr 25 14:55:37 2019 +0200
ZOOKEEPER-3369: 3.5 - Maven release artifacts cleanup
Author: Norbert Kalmar <[email protected]>
Reviewers: [email protected]
Closes #920 from nkalmar/ZK-3369-3.5
(cherry picked from commit bfda10ce219a02f5d6606e35fe8dc139e090692f)
Signed-off-by: Andor Molnar <[email protected]>
---
README.md | 48 +++--
pom.xml | 11 ++
zookeeper-assembly/pom.xml | 19 +-
.../src/main/assembly/bin-package.xml | 14 ++
zookeeper-docs/pom.xml | 7 +
.../lib/netty-all-4.1.29.Final.LICENSE.txt | 202 +++++++++++++++++++++
6 files changed, 274 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index e90d572..08467d3 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
-For the latest information about ZooKeeper, please visit our website at:
+# Apache ZooKeeper
+
+
+For the latest information about Apache ZooKeeper, please visit our website at:
http://zookeeper.apache.org/
@@ -6,38 +9,33 @@ and our wiki, at:
https://cwiki.apache.org/confluence/display/ZOOKEEPER
-Full documentation for this release can also be found in docs/index.html
-
---------------------------
-Packaging/release artifacts - Maven
+Packaging/release artifacts
+
+Either downloaded from https://zookeeper.apache.org/releases.html or
+found in zookeeper-assembly/target directory after building the project with
maven.
- A buildable tarball is located under zookeeper/target/ directory
+ apache-zookeeper-[version].tar.gz
- The artifacts for the modules are uploaded to maven central.
+ Contains all the source files which can be built by running:
+ mvn clean install
+ To generate an aggregated apidocs for zookeeper-server and
zookeeper-jute:
+ mvn javadoc:aggregate
+ (generated files will be at target/site/apidocs)
-Packaging/release artifacts - Ant
+ apache-zookeeper-[version]-bin.tar.gz
-The release artifact contains the following jar file at the toplevel:
+ Contains all the jar files required to run ZooKeeper
+ Full documentation can also be found in the docs folder
-zookeeper-<version>.jar - legacy jar file which contains all classes
- and source files. Prior to version 3.3.0 this
- was the only jar file available. It has the
- benefit of having the source included (for
- debugging purposes) however is also larger as
- a result
+As of version 3.5.5, the parent, zookeeper and zookeeper-jute artifacts
+are deployed to the central repository after the release
+is voted on and approved by the Apache ZooKeeper PMC:
-The release artifact contains the following jar files in "dist-maven"
directory:
+ https://repo1.maven.org/maven2/org/apache/zookeeper/zookeeper/
-zookeeper-<version>.jar - bin (binary) jar - contains only class
(*.class) files
-zookeeper-<version>-sources.jar - contains only src (*.java) files
-zookeeper-<version>-javadoc.jar - contains only javadoc files
+# Contributing
+We always welcome new contributors to the project! See [How to
Contribute](https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToContribute)
for details on how to submit patch through pull request and our contribution
workflow.
-These bin/src/javadoc jars were added specifically to support Maven/Ivy which
have
-the ability to pull these down automatically as part of your build process.
-The content of the legacy jar and the bin+sources jar are the same.
-As of version 3.3.0 bin/sources/javadoc jars contained in dist-maven directory
-are deployed to the Apache Maven repository after the release has been accepted
-by Apache:
- https://repository.apache.org/
diff --git a/pom.xml b/pom.xml
index 9c151df..db85d4c 100755
--- a/pom.xml
+++ b/pom.xml
@@ -645,7 +645,18 @@
<goal>jar</goal>
</goals>
</execution>
+ <execution>
+ <id>aggregate</id>
+ <phase>site</phase>
+ <goals>
+ <goal>aggregate</goal>
+ </goals>
+ </execution>
</executions>
+ <configuration>
+
<overview>zookeeper-server/src/main/resources/overview.html</overview>
+ <excludePackageNames>*.recipes.*</excludePackageNames>
+ </configuration>
</plugin>
<plugin>
<!-- Maven's deploy plugin only creates checksums during the
deployment of the jar artifacts to repo. -->
diff --git a/zookeeper-assembly/pom.xml b/zookeeper-assembly/pom.xml
index 99d53ff..050a8fb 100755
--- a/zookeeper-assembly/pom.xml
+++ b/zookeeper-assembly/pom.xml
@@ -75,7 +75,7 @@
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
- <id>make-assembly</id>
+ <id>source-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
@@ -83,9 +83,24 @@
<configuration>
<descriptors>
<descriptor>${project.basedir}/src/main/assembly/source-package.xml</descriptor>
+ </descriptors>
+ <finalName>apache-zookeeper-${project.version}</finalName>
+ <appendAssemblyId>false</appendAssemblyId>
+ <tarLongFileMode>posix</tarLongFileMode>
+ </configuration>
+ </execution>
+ <execution>
+ <id>bin-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ <configuration>
+ <descriptors>
<descriptor>${project.basedir}/src/main/assembly/bin-package.xml</descriptor>
</descriptors>
- <finalName>zookeeper-${project.version}</finalName>
+ <finalName>apache-zookeeper-${project.version}-bin</finalName>
+ <appendAssemblyId>false</appendAssemblyId>
<tarLongFileMode>posix</tarLongFileMode>
</configuration>
</execution>
diff --git a/zookeeper-assembly/src/main/assembly/bin-package.xml
b/zookeeper-assembly/src/main/assembly/bin-package.xml
index 0a4bf9a..529b483 100644
--- a/zookeeper-assembly/src/main/assembly/bin-package.xml
+++ b/zookeeper-assembly/src/main/assembly/bin-package.xml
@@ -62,6 +62,20 @@
<directoryMode>${rwx.file.permission}</directoryMode>
</fileSet>
<fileSet>
+ <!-- ZooKeeper jute generated api document -->
+
<directory>${project.basedir}/../zookeeper-jute/target/apidocs</directory>
+ <outputDirectory>docs/apidocs/zookeeper-jute</outputDirectory>
+ <fileMode>${rw.file.permission}</fileMode>
+ <directoryMode>${rwx.file.permission}</directoryMode>
+ </fileSet>
+ <fileSet>
+ <!-- ZooKeeper server generated api document -->
+
<directory>${project.basedir}/../zookeeper-server/target/apidocs</directory>
+ <outputDirectory>docs/apidocs/zookeeper-server</outputDirectory>
+ <fileMode>${rw.file.permission}</fileMode>
+ <directoryMode>${rwx.file.permission}</directoryMode>
+ </fileSet>
+ <fileSet>
<!-- License files for 3rd party libs -->
<directory>${project.basedir}/../zookeeper-server/src/main/resources/lib</directory>
<includes>
diff --git a/zookeeper-docs/pom.xml b/zookeeper-docs/pom.xml
index 94dff39..422573d 100644
--- a/zookeeper-docs/pom.xml
+++ b/zookeeper-docs/pom.xml
@@ -60,6 +60,13 @@
<skip>true</skip>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
</plugins>
</build>
diff --git
a/zookeeper-server/src/main/resources/lib/netty-all-4.1.29.Final.LICENSE.txt
b/zookeeper-server/src/main/resources/lib/netty-all-4.1.29.Final.LICENSE.txt
new file mode 100644
index 0000000..6279e52
--- /dev/null
+++ b/zookeeper-server/src/main/resources/lib/netty-all-4.1.29.Final.LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 1999-2005 The Apache Software Foundation
+
+ Licensed 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.
