You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@twill.apache.org by ch...@apache.org on 2016/08/22 01:13:35 UTC
twill git commit: Update site to remove outdate incubation information
Repository: twill
Updated Branches:
refs/heads/site 353ffa177 -> d4a3b6c69
Update site to remove outdate incubation information
Project: http://git-wip-us.apache.org/repos/asf/twill/repo
Commit: http://git-wip-us.apache.org/repos/asf/twill/commit/d4a3b6c6
Tree: http://git-wip-us.apache.org/repos/asf/twill/tree/d4a3b6c6
Diff: http://git-wip-us.apache.org/repos/asf/twill/diff/d4a3b6c6
Branch: refs/heads/site
Commit: d4a3b6c6912fd2004d489f32e597fae6a237830c
Parents: 353ffa1
Author: Terence Yim <ch...@apache.org>
Authored: Sun Aug 21 17:39:53 2016 -0700
Committer: Terence Yim <ch...@apache.org>
Committed: Sun Aug 21 18:13:27 2016 -0700
----------------------------------------------------------------------
src/site/markdown/GettingStarted.md | 12 +++----
src/site/markdown/HowToContribute.md | 10 ++++--
src/site/markdown/ReleaseGuide.md | 58 +++++++++++++------------------
3 files changed, 38 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/twill/blob/d4a3b6c6/src/site/markdown/GettingStarted.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/GettingStarted.md b/src/site/markdown/GettingStarted.md
index 98634fc..ba8d5de 100644
--- a/src/site/markdown/GettingStarted.md
+++ b/src/site/markdown/GettingStarted.md
@@ -28,7 +28,7 @@ For your application module
<dependency>
<groupId>org.apache.twill</groupId>
<artifactId>twill-api</artifactId>
- <version>0.6.0-incubating</version>
+ <version>0.7.0-incubating</version>
</dependency>
```
@@ -38,7 +38,7 @@ For the your Apache Twill YARN client module
<dependency>
<groupId>org.apache.twill</groupId>
<artifactId>twill-yarn</artifactId>
- <version>0.6.0-incubating</version>
+ <version>0.7.0-incubating</version>
</dependency>
```
@@ -47,7 +47,7 @@ For the your Apache Twill YARN client module
You can also clone the source and build the latest snapshot.
```sh
-$ git clone https://git-wip-us.apache.org/repos/asf/incubator-twill.git twill
+$ git clone https://git-wip-us.apache.org/repos/asf/twill.git twill
$ cd twill
$ mvn clean install
```
@@ -170,7 +170,7 @@ You can run the HelloWorld application from any node of the Hadoop cluster using
(be sure to add your ZooKeeper Host and Port):
```sh
-$ export CP=twill-examples-yarn-0.6.0-incubating-SNAPSHOT.jar:`hadoop classpath`
+$ export CP=twill-examples-yarn-0.7.0-incubating-SNAPSHOT.jar:`hadoop classpath`
$ java -cp $CP org.apache.twill.example.yarn.HelloWorld {zookeeper_host:port}
```
@@ -193,9 +193,9 @@ You can run the BundleJarExample application from any node of the Hadoop cluster
(be sure to add your ZooKeeper Host and Port):
```sh
-$ export CP=twill-examples-yarn-0.6.0-incubating-SNAPSHOT.jar:`hadoop classpath`
+$ export CP=twill-examples-yarn-0.7.0-incubating-SNAPSHOT.jar:`hadoop classpath`
$ java -cp $CP org.apache.twill.example.yarn.BundledJarExample {zookeeper_host:port} \
- twill-examples-echo-0.6.0-incubating-SNAPSHOT.jar echo.EchoMain arg1
+ twill-examples-echo-0.7.0-incubating-SNAPSHOT.jar echo.EchoMain arg1
```
Like with the HelloWorld example, you should see logs output to the terminal. Once the application is complete, check
http://git-wip-us.apache.org/repos/asf/twill/blob/d4a3b6c6/src/site/markdown/HowToContribute.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/HowToContribute.md b/src/site/markdown/HowToContribute.md
index eacbd9b..ba970e8 100644
--- a/src/site/markdown/HowToContribute.md
+++ b/src/site/markdown/HowToContribute.md
@@ -33,7 +33,7 @@ To report bugs or request new features, please open an issue in the
### Contributing Code
-We prefer contributions through [GitHub](https://github.com/apache/incubator-twill) pull requests. Please follow
+We prefer contributions through [GitHub](https://github.com/apache/twill) pull requests. Please follow
these steps to get your contributions in:
1. Open a new issue or pick up an existing one in the [Apache Twill JIRA](https://issues.apache.org/jira/browse/TWILL)
@@ -42,7 +42,7 @@ these steps to get your contributions in:
can also use the [dev mailing list](mail-lists.html) to discuss it first. This will help us understand your needs
and best guide your solution in a way that fits the project.
3. [Fork](https://help.github.com/articles/fork-a-repo) the
- [Apache Twill GitHub repo.](https://github.com/apache/incubator-twill)
+ [Apache Twill GitHub repo.](https://github.com/apache/twill)
4. Make the changes and send a [pull request](https://help.github.com/articles/using-pull-requests) from your
forked repo to the Apache Twill repo.
5. Please prefix your pull request title with the JIRA issue ID; for example, `(TWILL-87) Adding container placement policy`.
@@ -50,6 +50,10 @@ these steps to get your contributions in:
7. Once sent, code review will be done through the pull request.
8. Once all review issues are resolved, we will merge the changes into the `master` branch of the Apache Twill repo.
+### Coding Style
+
+* IntelliJ IDEA 2016 [settings](twill-idea-settings.jar)
+
### How to Merge Code Changes
Committer can merge code changes that are already reviewed into the `master` branch with the following steps:
@@ -58,7 +62,7 @@ Committer can merge code changes that are already reviewed into the `master` bra
2. Download the patch file from GitHub. You can append `.patch` to the end of the GitHub pull request URL to get the patch file.
- curl -L -O https://github.com/apache/incubator-twill/pull/${PR_NUMBER}.patch
+ curl -L -O https://github.com/apache/twill/pull/${PR_NUMBER}.patch
3. Edit the patch file and add the following line in the commit message for closing the pull request.
This closes #${PR_NUMBER} from GitHub.
http://git-wip-us.apache.org/repos/asf/twill/blob/d4a3b6c6/src/site/markdown/ReleaseGuide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/ReleaseGuide.md b/src/site/markdown/ReleaseGuide.md
index 2e6ebf1..86253ab 100644
--- a/src/site/markdown/ReleaseGuide.md
+++ b/src/site/markdown/ReleaseGuide.md
@@ -30,7 +30,7 @@ This guide describes the steps to building and releasing Apache Twill artifacts.
Generate a GPG keypair for signing artifacts, if you don't already have one.
See [GPG key generation](http://www.apache.org/dev/openpgp.html#generate-key) on how to do so.
Make sure the public key is published to a public key server, as well as added to the Twill
-[KEYS](https://dist.apache.org/repos/dist/release/incubator/twill/KEYS) file.
+[KEYS](https://dist.apache.org/repos/dist/release/twill/KEYS) file.
#### Generate an encrypted password for maven deploy
Generate an encrypted password for your apache id using maven
@@ -55,19 +55,19 @@ The `${RELEASE_VERSION}` is something such as `0.5.0`.
#### Update the version to the non-snapshot version
```
-mvn versions:set -DgenerateBackupPoms=false -DnewVersion=${RELEASE_VERSION}-incubating
-git commit . -m "Prepare for releasing ${RELEASE_VERSION}-incubating"
+mvn versions:set -DgenerateBackupPoms=false -DnewVersion=${RELEASE_VERSION}
+git commit . -m "Prepare for releasing ${RELEASE_VERSION}"
```
#### Create a new signed tag for the release
```
-git tag -s v${RELEASE_VERSION}-incubating -m 'Releasing ${RELEASE_VERSION}-incubating'
+git tag -s v${RELEASE_VERSION} -m 'Releasing ${RELEASE_VERSION}'
```
#### Push both the new branch and the tag
```
git push origin branch-${RELEASE_VERSION}
-git push origin v${RELEASE_VERSION}-incubating
+git push origin v${RELEASE_VERSION}
```
#### Start gpg-agent
@@ -85,29 +85,29 @@ mvn clean prepare-package -DskipTests -Dremoteresources.skip=true -P hadoop-2.0
mvn prepare-package -DskipTests -Dremoteresources.skip=true -P hadoop-2.3 &&
mvn deploy -DskipTests -Dremoteresources.skip=true -P hadoop-2.3 -P apache-release
```
-The source tarball can be found in `target/apache-twill-${RELEASE_VERSION}-incubating-source-release.tar.gz`
+The source tarball can be found in `target/apache-twill-${RELEASE_VERSION}-source-release.tar.gz`
after the above command has successfully completed.
#### Compute the MD5 and SHA512 of the source release tarball
```
cd target
-md5 -q apache-twill-${RELEASE_VERSION}-incubating-source-release.tar.gz > apache-twill-${RELEASE_VERSION}-incubating-source-release.tar.gz.md5
-shasum -a 512 apache-twill-${RELEASE_VERSION}-incubating-source-release.tar.gz > apache-twill-${RELEASE_VERSION}-incubating-source-release.tar.gz.sha512
+md5 -q apache-twill-${RELEASE_VERSION}-source-release.tar.gz > apache-twill-${RELEASE_VERSION}-source-release.tar.gz.md5
+shasum -a 512 apache-twill-${RELEASE_VERSION}-source-release.tar.gz > apache-twill-${RELEASE_VERSION}-source-release.tar.gz.sha512
```
#### Prepare release artifacts
1. Checkin the source release tarball, together with the signature, md5 and sha512 files
- to `dist.apache.org/repos/dist/dev/incubator/twill/${RELEASE_VERSION}-incubating-rc1/src/`
+ to `dist.apache.org/repos/dist/dev/twill/${RELEASE_VERSION}-rc1/src/`
1. Create a `CHANGES.txt` file to describe the changes in the release and checkin the file
- to `dist.apache.org/repos/dist/dev/incubator/twill/${RELEASE_VERSION}-incubating-rc1/CHANGES.txt`
+ to `dist.apache.org/repos/dist/dev/twill/${RELEASE_VERSION}-rc1/CHANGES.txt`
1. Go to [https://repository.apache.org](https://repository.apache.org) and close the staging repository.
#### Increase the version in master
```
git checkout master
git merge --no-ff branch-${RELEASE_VERSION}
-mvn versions:set -DgenerateBackupPoms=false -DnewVersion=${NEXT_RELEASE_VERSION}-incubating-SNAPSHOT
-git commit . -m "Bump version to ${NEXT_RELEASE_VERSION}-incubating-SNAPSHOT"
+mvn versions:set -DgenerateBackupPoms=false -DnewVersion=${NEXT_RELEASE_VERSION}-SNAPSHOT
+git commit . -m "Bump version to ${NEXT_RELEASE_VERSION}-SNAPSHOT"
git push origin master
```
@@ -116,22 +116,22 @@ Create a vote in the `dev@twill` mailing list and wait for 72 hours for the vote
Here is a template for the email:
```
-Subject: [VOTE] Release of Apache Twill-${RELEASE_VERSION}-incubating [rc1]
+Subject: [VOTE] Release of Apache Twill-${RELEASE_VERSION} [rc1]
==========================================================================
Hi all,
-This is a call for a vote on releasing Apache Twill ${RELEASE_VERSION}-incubating, release candidate 1. This
+This is a call for a vote on releasing Apache Twill ${RELEASE_VERSION}, release candidate 1. This
is the [Nth] release of Twill.
The source tarball, including signatures, digests, etc. can be found at:
-https://dist.apache.org/repos/dist/dev/incubator/twill/${RELEASE_VERSION}-incubating-rc1/src
+https://dist.apache.org/repos/dist/dev/twill/${RELEASE_VERSION}-rc1/src
-The tag to be voted upon is v${RELEASE_VERSION}-incubating:
-https://git-wip-us.apache.org/repos/asf?p=incubator-twill.git;a=shortlog;h=refs/tags/v${RELEASE_VERSION}-incubating
+The tag to be voted upon is v${RELEASE_VERSION}:
+https://git-wip-us.apache.org/repos/asf?p=twill.git;a=shortlog;h=refs/tags/v${RELEASE_VERSION}
The release hash is [REF]:
-https://git-wip-us.apache.org/repos/asf?p=incubator-twill.git;a=commit;h=[REF]
+https://git-wip-us.apache.org/repos/asf?p=twill.git;a=commit;h=[REF]
The Nexus Staging URL:
https://repository.apache.org/content/repositories/orgapachetwill-[STAGE_ID]
@@ -140,16 +140,16 @@ Release artifacts are signed with the following key:
[URL_TO_SIGNER_PUBLIC_KEY]
KEYS file available:
-https://dist.apache.org/repos/dist/dev/incubator/twill/KEYS
+https://dist.apache.org/repos/dist/dev/twill/KEYS
For information about the contents of this release, see:
-https://dist.apache.org/repos/dist/dev/incubator/twill/${RELEASE_VERSION}-incubating-rc1/CHANGES.txt
+https://dist.apache.org/repos/dist/dev/twill/${RELEASE_VERSION}-rc1/CHANGES.txt
-Please vote on releasing this package as Apache Twill ${RELEASE_VERSION}-incubating
+Please vote on releasing this package as Apache Twill ${RELEASE_VERSION}
The vote will be open for 72 hours.
-[ ] +1 Release this package as Apache Twill ${RELEASE_VERSION}-incubating
+[ ] +1 Release this package as Apache Twill ${RELEASE_VERSION}
[ ] +0 no opinion
[ ] -1 Do not release this package because ...
@@ -162,13 +162,13 @@ After the vote is up for 72 hours and having at least three +1 binding votes and
votes, close the vote by replying to the voting thread. Here is a template for the reply email:
```
-Subject: [RESULT][VOTE] Release of Apache Twill-${RELEASE_VERSION}-incubating [rc1]
+Subject: [RESULT][VOTE] Release of Apache Twill-${RELEASE_VERSION} [rc1]
==================================================================================
Hi all,
After being opened for over 72 hours, the vote for releasing Apache Twill
-${RELEASE_VERSION}-incubating passed with n binding +1s and no 0 or -1.
+${RELEASE_VERSION} passed with n binding +1s and no 0 or -1.
Binding +1s:
[BINDING_+1_NAMES]
@@ -179,17 +179,9 @@ Thanks,
[YOUR_NAME]
```
-#### Vote for release from IPMC
-1. Create a vote in the `general@` mailing list for the IPMC to vote for the
- release.
-1. 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.
-1. After the vote in `general@` is completed with at least three +1 binding votes, close
- the vote by replying to the voting thread.
-
#### Finalize the release
1. Copy the release artifacts and `CHANGES.txt` from the dev to release directory at
- `dist.apache.org/repos/dist/release/incubator/twill/${RELEASE_VERSION}-incubating`
+ `dist.apache.org/repos/dist/release/twill/${RELEASE_VERSION}`
1. Go to [https://repository.apache.org](https://repository.apache.org) and release the
staging repository.
1. Send out an announcement of the release to `dev@twill` and `announce@` mailing lists.