Repository: incubator-tephra Updated Branches: refs/heads/release-changes f8e9c43f2 -> fd1d6a1c1 (forced update)
Misc release changes Project: http://git-wip-us.apache.org/repos/asf/incubator-tephra/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tephra/commit/fd1d6a1c Tree: http://git-wip-us.apache.org/repos/asf/incubator-tephra/tree/fd1d6a1c Diff: http://git-wip-us.apache.org/repos/asf/incubator-tephra/diff/fd1d6a1c Branch: refs/heads/release-changes Commit: fd1d6a1c128d0c1e613e348f07c800df0c2d72ae Parents: ab52491 Author: poorna <[email protected]> Authored: Wed May 11 19:13:54 2016 -0700 Committer: poorna <[email protected]> Committed: Fri May 13 15:19:16 2016 -0700 ---------------------------------------------------------------------- README.rst | 15 +- RELEASING.rst | 154 +++++++++++++----- docs/_images/tephra_logo_dark_background.png | Bin 0 -> 12301 bytes docs/_images/tephra_logo_light_background.png | Bin 16528 -> 13883 bytes .../tephra_logo_light_background_small.png | Bin 0 -> 5382 bytes docs/_images/tephra_logo_light_bkgnd_small.png | Bin 9042 -> 0 bytes docs/_images/tephra_logo_light_bknd_cask.png | Bin 12676 -> 0 bytes pom.xml | 162 ++++++------------- src/assemble/bin.xml | 3 + tephra-distribution/pom.xml | 8 +- 10 files changed, 183 insertions(+), 159 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/README.rst ---------------------------------------------------------------------- diff --git a/README.rst b/README.rst index 02380d0..5c72805 100644 --- a/README.rst +++ b/README.rst @@ -53,7 +53,7 @@ client skips cells associated with any of the excluded transaction IDs. The rea applied through a server-side filter injected by the ``TransactionProcessor`` coprocessor. TransactionProcessor Coprocessor -.................................. +................................ The ``TransactionProcessor`` coprocessor is loaded on all HBase tables where transactional reads and writes are performed. When clients read data, it coordinates the server-side filtering @@ -70,8 +70,9 @@ found in our `Transactions over HBase Is It Building? ----------------- -Status of continuous integration build at `Travis CI <https://travis-ci.org/caskdata/tephra>`__: |(BuildStatus)| +--------------- +Status of continuous integration build at +`Travis CI <https://travis-ci.org/apache/incubator-tephra>`__: |(BuildStatus)| Requirements ------------ @@ -605,7 +606,7 @@ assisting others on the mailing list. Bug Reports & Feature Requests .............................. -Bugs and tasks are tracked in a public JIRA `issue tracker <https://issues.cask.co/browse/TEPHRA>`__. +Bugs and tasks are tracked in a public JIRA `issue tracker <https://issues.apache.org/jira/browse/TEPHRA>`__. Apache Tephra User Groups and Mailing Lists ........................................... @@ -676,7 +677,7 @@ No endorsement by The Apache Software Foundation is implied by the use of these .. |(TM)| unicode:: U+2122 .. trademark sign :trim: -.. |(Tephra)| image:: docs/_images/tephra_logo_light_bknd_cask.png +.. |(Tephra)| image:: docs/_images/tephra_logo_light_background_small.png -.. |(BuildStatus)| image:: https://travis-ci.org/caskdata/tephra.svg?branch=develop - :target: https://travis-ci.org/caskdata/tephra +.. |(BuildStatus)| image:: https://travis-ci.org/apache/incubator-tephra.svg?branch=master + :target: https://travis-ci.org/apache/incubator-tephra http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/RELEASING.rst ---------------------------------------------------------------------- diff --git a/RELEASING.rst b/RELEASING.rst index 708efe3..f8d8322 100644 --- a/RELEASING.rst +++ b/RELEASING.rst @@ -1,8 +1,8 @@ -================ -Releasing Tephra -================ +======================= +Releasing Apache Tephra +======================= -This page describes the step-by-step process of how to perform an official Tephra version release, +This page describes the step-by-step process of how to perform an official Apache Tephra version release, including deploying the release artifacts to Maven repositories and the additional administrative steps to complete the release process. @@ -12,7 +12,7 @@ Prerequisites Maven Settings File ------------------- -Prior to performing a Tephra release, you must have an entry such as this in your +Prior to performing an Apache Tephra release, you must have an entry such as this in your ``~/.m2/settings.xml`` file to authenticate when deploying the release artifacts:: <?xml version="1.0" encoding="UTF-8"?> @@ -21,12 +21,12 @@ Prior to performing a Tephra release, you must have an entry such as this in you xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <servers> <server> - <id>sonatype.snapshots</id> + <id>apache.snapshots.https</id> <username>USERNAME</username> <password>PASSWORD</password> </server> <server> - <id>sonatype.release</id> + <id>apache.releases.https</id> <username>USERNAME</username> <password>PASSWORD</password> </server> @@ -55,15 +55,15 @@ Performing the Release Ensure Local Branch is Up-to-date --------------------------------- -First, make sure your local copy of the ``develop`` branch is up-to-date with all changes:: +First, make sure your local copy of the ``master`` branch is up-to-date with all changes:: - git checkout develop + git checkout master git pull Create the Release Branch ------------------------- -Next, create a release branch from ``develop``:: +Next, create a release branch from ``master``:: git checkout -b release/N.N.N @@ -74,7 +74,7 @@ Prepare the Release While on the release branch, prepare the release:: - mvn clean release:prepare -P release + mvn clean release:prepare -P apache-release This will prompt you for the release version and the git tag to use for the release. By convention, we use ``vN.N.N`` for the release tag (ie. v0.6.0 for release 0.6.0). @@ -84,50 +84,132 @@ Perform the Release Perform the release by running:: - mvn release:perform -P release + mvn release:perform -P apache-release This will checkout the source code using the release tag, build the release and deploy it to the -oss.sonatype.org repository. +repository.apache.org repository. Also it creates a source tarball +``apache-tephra-0.8.0-incubating-SNAPSHOT-source-release.tar.gz`` in ``target`` directory. -Release the Staging Repository in Artifactory ---------------------------------------------- +Prepare Release Artifacts +------------------------- -Release the artifact bundle in Artifactory: +1. Checkin the source release tarball, together with the signature, md5 and sha512 files found in + ``target/`` directory + to ``dist.apache.org/repos/dist/dev/incubator/tephra/${RELEASE_VERSION}-incubating-rc1/src/``. +2. Create a CHANGES.txt file to describe the changes in the release and checkin the file to + ``dist.apache.org/repos/dist/dev/incubator/tephra/${RELEASE_VERSION}-incubating-rc1/CHANGES.txt``. +3. Close the staging repository at https://repository.apache.org -1. Login to https://oss.sonatype.org (you will need to use the same credentials you have - configured in your ``~/.m2/settings.xml`` file). -2. Go to "Staging Repos". -3. Find the "comcontinuuity" repo with the Tephra release. Be sure to expand the contents of the - repo to confirm that it contains the correct Tephra artifacts. -4. Click on the "Release" button at top, and enter a brief description, such as "Tephra N.N.N - release". -Update Git Branches -------------------- +Update POM Version in master +---------------------------- + +Update the POMs in ``master`` by:: -After the release is complete, update the other git branches with the release changes:: - git checkout master git merge release/N.N.N git push origin master - git checkout develop - git merge master - git push origin develop +Vote for the Release in Dev Mailing List +---------------------------------------- + +Create a vote in the dev@tephra mailing list, and wait for 72 hours for the vote result. +Here is a template for the email:: + + Subject: [VOTE] Release of Apache Tephra-${RELEASE_VERSION}-incubating [rc1] + ============================================================================ + + Hi all, + + This is a call for a vote on releasing Apache Tephra ${RELEASE_VERSION}-incubating, release candidate 1. This + is the [Nth] release of Tephra. + + The source tarball, including signatures, digests, etc. can be found at: + https://dist.apache.org/repos/dist/dev/incubator/tephra/${RELEASE_VERSION}-incubating-rc1/src + + The tag to be voted upon is v${RELEASE_VERSION}-incubating: + https://git-wip-us.apache.org/repos/asf?p=incubator-tephra.git;a=shortlog;h=refs/tags/v${RELEASE_VERSION}-incubating + + The release hash is [REF]: + https://git-wip-us.apache.org/repos/asf?p=incubator-tephra.git;a=commit;h=[REF] + + The Nexus Staging URL: + https://repository.apache.org/content/repositories/orgapachetephra-[STAGE_ID] + + Release artifacts are signed with the following key: + [URL_TO_SIGNER_PUBLIC_KEY] + + KEYS file available: + https://dist.apache.org/repos/dist/dev/incubator/tephra/KEYS + + For information about the contents of this release, see: + https://dist.apache.org/repos/dist/dev/incubator/tephra/${RELEASE_VERSION}-incubating-rc1/CHANGES.txt + Please vote on releasing this package as Apache Tephra ${RELEASE_VERSION}-incubating + + The vote will be open for 72 hours. + + [ ] +1 Release this package as Apache Tephra ${RELEASE_VERSION}-incubating + [ ] +0 no opinion + [ ] -1 Do not release this package because ... + + Thanks, + [YOUR_NAME] + +Consolidate Vote Result +----------------------- + +After the vote is up for 72 hours and having at least three +1 binding votes and no -1 votes, +close the vote by replying to the voting thread. Here is a template for the reply email:: + + Subject: [RESULT][VOTE] Release of Apache Tephra-${RELEASE_VERSION}-incubating [rc1] + ================================================================================== + + Hi all, + + After being opened for over 72 hours, the vote for releasing Apache Tephra + ${RELEASE_VERSION}-incubating passed with n binding +1s and no 0 or -1. + + Binding +1s: + [BINDING_+1_NAMES] + + I am going to create a vote in the general@ list. + + Thanks, + [YOUR_NAME] + +Vote for the Release from IPMC +------------------------------ + +1. Create a vote in the general@ mailing list for the IPMC to vote for the release. +2. Wait for 72 hours for the vote result. Use the same template as the dev vote, with the addition + of links to the dev vote and result mail thread. +3. After the vote in general@ is completed with at least three +1 binding votes, close the vote by + replying to the voting thread. + +Release the Staging Repository in Artifactory +--------------------------------------------- + +Release the artifact bundle in Artifactory: + +1. Login to https://repository.apache.org. +2. Go to "Staging Repos". +3. Find the "orgapachetephra" repo with the Tephra release. Be sure to expand the contents of the + repo to confirm that it contains the correct Tephra artifacts. +4. Click on the "Release" button at top, and enter a brief description, such as "Apache Tephra N.N.N + release". Announcing and Completing the Release ===================================== -Mark the release as complete in JIRA (in the Tephra Administration section): +Mark the release as complete in JIRA (in the Apache Tephra Administration section): 1. Add a release for the next version, if necessary 2. Set a release date and release the released version -Create a new release in github: +Release the source tarball: -1. Create a new release based on the release tag used -2. Add the release description -3. Upload release artifacts from ``tephra-distribution/target/`` +1. Copy the release artifacts and CHANGES.txt from the dev to release directory at + ``dist.apache.org/repos/dist/release/incubator/tephra/${RELEASE_VERSION}-incubating`` -Finally, announce the release on the Tephra mailing lists: [email protected], [email protected] +Finally, announce the release on the mailing lists: dev@tephra and announce@ http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/docs/_images/tephra_logo_dark_background.png ---------------------------------------------------------------------- diff --git a/docs/_images/tephra_logo_dark_background.png b/docs/_images/tephra_logo_dark_background.png new file mode 100644 index 0000000..212edf1 Binary files /dev/null and b/docs/_images/tephra_logo_dark_background.png differ http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/docs/_images/tephra_logo_light_background.png ---------------------------------------------------------------------- diff --git a/docs/_images/tephra_logo_light_background.png b/docs/_images/tephra_logo_light_background.png index 9bc5e73..4601908 100644 Binary files a/docs/_images/tephra_logo_light_background.png and b/docs/_images/tephra_logo_light_background.png differ http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/docs/_images/tephra_logo_light_background_small.png ---------------------------------------------------------------------- diff --git a/docs/_images/tephra_logo_light_background_small.png b/docs/_images/tephra_logo_light_background_small.png new file mode 100644 index 0000000..fd02cdc Binary files /dev/null and b/docs/_images/tephra_logo_light_background_small.png differ http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/docs/_images/tephra_logo_light_bkgnd_small.png ---------------------------------------------------------------------- diff --git a/docs/_images/tephra_logo_light_bkgnd_small.png b/docs/_images/tephra_logo_light_bkgnd_small.png deleted file mode 100644 index 6af34ed..0000000 Binary files a/docs/_images/tephra_logo_light_bkgnd_small.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/docs/_images/tephra_logo_light_bknd_cask.png ---------------------------------------------------------------------- diff --git a/docs/_images/tephra_logo_light_bknd_cask.png b/docs/_images/tephra_logo_light_bknd_cask.png deleted file mode 100644 index bfcd174..0000000 Binary files a/docs/_images/tephra_logo_light_bknd_cask.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index f85b59c..9433071 100644 --- a/pom.xml +++ b/pom.xml @@ -24,7 +24,7 @@ <parent> <groupId>org.apache</groupId> <artifactId>apache</artifactId> - <version>13</version> + <version>17</version> </parent> <groupId>org.apache.tephra</groupId> @@ -458,28 +458,6 @@ </executions> </plugin> - <!-- Maven assembly --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-assembly-plugin</artifactId> - <version>2.4</version> - <configuration> - <descriptors> - <descriptor>src/assemble/bin.xml</descriptor> - </descriptors> - </configuration> - </plugin> - - <!-- Deploy plugin --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-deploy-plugin</artifactId> - <version>2.8</version> - <configuration> - <deployAtEnd>true</deployAtEnd> - </configuration> - </plugin> - <!-- Release plugin --> <plugin> <groupId>org.apache.maven.plugins</groupId> @@ -491,6 +469,14 @@ <autoVersionSubmodules>true</autoVersionSubmodules> </configuration> </plugin> + + <!-- Checksum plugin --> + <plugin> + <inherited>false</inherited> + <groupId>net.ju-n.maven.plugins</groupId> + <artifactId>checksum-maven-plugin</artifactId> + <version>1.3</version> + </plugin> </plugins> </pluginManagement> @@ -575,106 +561,56 @@ </build> </profile> - <!-- Profile for release. Generates extra artifacts --> + <!-- Profile to generate apache release --> <profile> - <id>release</id> + <id>apache-release</id> <build> - <pluginManagement> - <plugins> - <!-- Source jar --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-source-plugin</artifactId> - <version>2.2.1</version> - <configuration> - <excludeResources>true</excludeResources> - </configuration> - <executions> - <execution> - <id>attach-sources</id> - <phase>package</phase> - <goals> - <goal>jar-no-fork</goal> - </goals> - </execution> - </executions> - </plugin> - - <!-- Javadoc jar --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>2.9</version> - <configuration> - <excludePackageNames>*.internal.*</excludePackageNames> - <links> - <link>http://docs.oracle.com/javase/7/docs/api/</link> - </links> - </configuration> - <executions> - <execution> - <id>attach-javadoc</id> - <phase>package</phase> - <goals> - <goal>jar</goal> - </goals> - </execution> - </executions> - </plugin> - - <!-- GPG signature --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-gpg-plugin</artifactId> - <version>1.5</version> - <configuration> - <passphrase>${gpg.passphrase}</passphrase> - <useAgent>${gpg.useagent}</useAgent> - </configuration> - <executions> - <execution> - <goals> - <goal>sign</goal> - </goals> - </execution> - </executions> - </plugin> - - <!-- Nexus deploy plugin --> - <plugin> - <groupId>org.sonatype.plugins</groupId> - <artifactId>nexus-staging-maven-plugin</artifactId> - <version>1.6.2</version> - <extensions>true</extensions> - <configuration> - <nexusUrl>https://oss.sonatype.org</nexusUrl> - <serverId>sonatype.release</serverId> - <stagingProfileId>655dc88dc770c3</stagingProfileId> - </configuration> - </plugin> - </plugins> - </pluginManagement> - <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-source-plugin</artifactId> - <version>2.2.1</version> + <artifactId>maven-assembly-plugin</artifactId> + <configuration> + <finalName>apache-tephra-${project.version}</finalName> + <formats> + <format>tar.gz</format> + </formats> + </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>2.9</version> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-gpg-plugin</artifactId> - <version>1.5</version> + <artifactId>maven-remote-resources-plugin</artifactId> + <configuration> + <!-- Disable this plugin so that it won't generate a DEPENDENCIES file in the source tar --> + <skip>true</skip> + </configuration> </plugin> + + <!-- Compute checksum of release artifact --> <plugin> - <groupId>org.sonatype.plugins</groupId> - <artifactId>nexus-staging-maven-plugin</artifactId> - <version>1.6.2</version> + <inherited>false</inherited> + <groupId>net.ju-n.maven.plugins</groupId> + <artifactId>checksum-maven-plugin</artifactId> + <executions> + <execution> + <goals> + <goal>files</goal> + </goals> + </execution> + </executions> + <configuration> + <algorithms> + <algorithm>MD5</algorithm> + <algorithm>SHA-512</algorithm> + </algorithms> + <fileSets> + <fileSet> + <directory>${project.build.directory}</directory> + <includes> + <include>apache-tephra-${project.version}-${sourceReleaseAssemblyDescriptor}.tar.gz</include> + </includes> + </fileSet> + </fileSets> + </configuration> </plugin> </plugins> </build> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/src/assemble/bin.xml ---------------------------------------------------------------------- diff --git a/src/assemble/bin.xml b/src/assemble/bin.xml index 778df13..5513d1a 100644 --- a/src/assemble/bin.xml +++ b/src/assemble/bin.xml @@ -55,7 +55,10 @@ <outputDirectory>.</outputDirectory> <includes> <include>LICENSE</include> + <include>NOTICE</include> <include>README.rst</include> + <include>KEYS</include> + <include>DISCLAIMER</include> </includes> <fileMode>0644</fileMode> </fileSet> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/fd1d6a1c/tephra-distribution/pom.xml ---------------------------------------------------------------------- diff --git a/tephra-distribution/pom.xml b/tephra-distribution/pom.xml index 872c51c..11175c9 100644 --- a/tephra-distribution/pom.xml +++ b/tephra-distribution/pom.xml @@ -78,6 +78,7 @@ <build> <plugins> + <!-- Generate binary distribution artifact --> <plugin> <artifactId>maven-assembly-plugin</artifactId> <executions> @@ -88,7 +89,8 @@ <goal>single</goal> </goals> <configuration> - <finalName>tephra-${project.version}</finalName> + <finalName>apache-tephra-${project.version}</finalName> + <appendAssemblyId>true</appendAssemblyId> <formats> <format>tar.gz</format> </formats> @@ -160,8 +162,8 @@ <include name="**/jacoco.exec" /> </fileset> </executiondata> - <structure name="Tephra Coverage Project"> - <group name="Tephra"> + <structure name="Apache Tephra Coverage Project"> + <group name="Apache Tephra"> <classfiles> <fileset dir="../"> <include name="**/*.class" />
