You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by me...@apache.org on 2018/06/08 23:04:58 UTC
[beam-site] branch mergebot updated (c77c0eb -> dac24e6)
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a change to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git.
from c77c0eb This closes #464
add 4b67f98 Prepare repository for deployment.
new a48e1ec Updating release guide to use Gradle commands.
new 8323673 Addressing comments. Improving commands.
new 3c14234 Addressing comments. Improving commands.
new 45e1354 Update release guide for publishing source zip from GitHub
new 81c1aae Addressing TODOs
new 3755d25 Address comments.
new 3c8bd17 Improving.
new bbc63f6 Add more updates
new 207220b More updates
new f4e460a Addressed Alan's comments
new 167141b Add instructions about how to stage python binaries
new 305b85c copy renamed zi[ file to sdks/python/staging subdir
new d963471 Update gradle publish with --no-parallel --no-daemon
new dac24e6 This closes #424
The 14 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
content/contribute/index.html | 153 ++++++++++++++++++++++++-----
src/contribute/release-guide.md | 209 +++++++++++++++++++++++++++++-----------
2 files changed, 282 insertions(+), 80 deletions(-)
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 10/14: Addressed Alan's comments
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit f4e460ab7f712f5e75a0d0134786aa60e9d711e4
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Tue Jun 5 15:28:20 2018 -0700
Addressed Alan's comments
---
src/contribute/release-guide.md | 11 +++--------
1 file changed, 3 insertions(+), 8 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index a4a83e5..b0fc7a1 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -255,7 +255,7 @@ Version represents the release currently underway, while next version specifies
BASE_RELEASE=2.5.0
RELEASE=2.5.1
- NEXT_VERSION_IN_BASE_BRANCH=2.5.0
+ NEXT_VERSION_IN_BASE_BRANCH=2.6.0
git checkout tags/${BASE_RELEASE}
Create a new branch, and update version files in the master branch.
@@ -274,18 +274,13 @@ Create a new branch, and update version files in the master branch.
Check out the release branch.
git checkout ${BRANCH}
-
-The rest of this guide assumes that commands are run in the root of a repository on `${BRANCH_NAME}` with the above environment variables set.
-
-### Update the beam version on master to the next dev version
-* [beam/build_rules.gradle](https://github.com/apache/beam/blob/master/build_rules.gradle): update value of 'version'(e.g, '2.5.0' to '2.6.0')
-* [beam/pom.xml](https://github.com/apache/beam/blob/master/pom.xml): update value of 'version' field(e.g, '2.5.0-SNAPSHOT' to '2.6.0-SNAPSHOT')
+
+The rest of this guide assumes that commands are run in the root of a repository on `${BRANCH}` with the above environment variables set.
### Update the Python SDK version
Update [sdks/python/apache_beam/version.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/version.py) in both master branch and release branch.
-* In the master branch, change the Python SDK version to the next dev version(e.g, `2.5.0-dev` to `2.6.0-dev`).
* In the release branch, update the Python SDK version to the release version(e.g. `2.5.0-dev` to `2.5.0`).
### Update release specific configurations
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 06/14: Address comments.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 3755d25e5dc11e6daf3603ee51d0ea9d7efd36eb
Author: Pablo <pa...@users.noreply.github.com>
AuthorDate: Fri May 18 09:52:56 2018 -0700
Address comments.
---
src/contribute/release-guide.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index cbcf1ca..d718401 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -158,7 +158,7 @@ Adjust any of the above properties to the improve clarity and presentation of th
### Verify that a Release Build Works
-Run `./gradlew -PisRelease clean build` to ensure that the build processes that are specific to that profile are in good shape.
+From a new workspace, run `git clean -fdx` to clean, and then `./gradlew -PisRelease build` to ensure that the build processes necessary for release are in good shape.
### Update and Verify Javadoc
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 07/14: Improving.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 3c8bd173e004e0d109de94db16ad9f413d773578
Author: Pablo <pa...@users.noreply.github.com>
AuthorDate: Fri May 18 10:02:35 2018 -0700
Improving.
---
src/contribute/release-guide.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index d718401..f49a9a4 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -158,7 +158,7 @@ Adjust any of the above properties to the improve clarity and presentation of th
### Verify that a Release Build Works
-From a new workspace, run `git clean -fdx` to clean, and then `./gradlew -PisRelease build` to ensure that the build processes necessary for release are in good shape.
+From a new workspace, run `git clean -fdx` to clean, and then `./gradlew -PisRelease build --no-parallel` to ensure that the build processes necessary for release are in good shape.
### Update and Verify Javadoc
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 02/14: Addressing comments. Improving commands.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 8323673ed5d2bf615bf80dec7a5816ed88c674cf
Author: Pablo <pa...@google.com>
AuthorDate: Fri Apr 20 10:50:56 2018 -0700
Addressing comments. Improving commands.
---
src/contribute/release-guide.md | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index 3d6b5cc..e6a3792 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -180,12 +180,13 @@ Javadoc to the Javadoc for other modules that Beam depends on.
### Create a release branch
-Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the code repository, and update version information on the original branch.
+Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the Apache code repository, and update version information on the original branch.
Check out the version of the codebase from which you start the release. For a new minor or major release, this may be `HEAD` of the `master` branch. To build a hotfix/incremental release, instead of the `master` branch, use the release tag of the release being patched. (Please make sure your cloned repository is up-to-date before starting.)
git checkout <master branch OR release tag>
+**NOTE**: If you are doing an incremental/hotfix release (e.g. 2.5.1), please check out the previous release tag, rather than the master branch.
Set up a few environment variables to simplify Maven commands that follow. (We use `bash` Unix syntax in this guide.)
@@ -195,7 +196,7 @@ Set up a few environment variables to simplify Maven commands that follow. (We u
Version represents the release currently underway, while next version specifies the anticipated next version to be released from that branch. Normally, 1.2.0 is followed by 1.3.0, while 1.2.3 is followed by 1.2.4.
-**NOTE**: Only if you are doing an incremental/hotfix releasei (e.g. 2.5.1), please check out the previous release tag, before running the following instructions:
+**NOTE**: Only if you are doing an incremental/hotfix release (e.g. 2.5.1), please check out the previous release tag, before running the following instructions:
BASE_RELEASE=2.5.0
RELEASE=2.5.1
@@ -207,9 +208,9 @@ Create a new branch, and update version files in the master branch.
git branch ${BRANCH}
# Now change the version in existing gradle files, and Python files
- sed -i 's/'$RELEASE'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g' build_rules.gradle
- sed -i 's/'$RELEASE'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g' gradle.properties
- sed -i 's/'$RELEASE'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g' sdks/python/apache_beam/version.py
+ sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" build_rules.gradle
+ sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" gradle.properties
+ sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" sdks/python/apache_beam/version.py
# Save changes in master branch
git add gradle.properties build_rules.gradle
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 14/14: This closes #424
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit dac24e6bee4b3202fbd33543f9d66e80e8b7cd32
Merge: 4b67f98 d963471
Author: Mergebot <me...@apache.org>
AuthorDate: Fri Jun 8 16:04:24 2018 -0700
This closes #424
src/contribute/release-guide.md | 209 +++++++++++++++++++++++++++++-----------
1 file changed, 151 insertions(+), 58 deletions(-)
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 12/14: copy renamed zi[ file to sdks/python/staging
subdir
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 305b85cb80543ded6431d32035de279da41606be
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Thu Jun 7 09:14:25 2018 -0700
copy renamed zi[ file to sdks/python/staging subdir
---
src/contribute/release-guide.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index eec7883..4c9c536 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -381,7 +381,8 @@ Build python binaries in release branch in sdks/python dir.
python setup.py sdist --format=zip
cd dist
- mv apache-beam-${RELEASE}.zip apache-beam-${RELEASE}-python.zip
+ cp apache-beam-${RELEASE}.zip staging/apache-beam-${RELEASE}-python.zip
+ cd staging
Create hashes and sign the binaries
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 04/14: Update release guide for publishing source zip
from GitHub
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 45e1354e1a5a9a6f14f0a6f1387fae7c6b9969d7
Author: Scott Wegner <sw...@google.com>
AuthorDate: Tue May 1 14:36:52 2018 -0700
Update release guide for publishing source zip from GitHub
---
src/contribute/release-guide.md | 32 +++++++++++++++-----------------
1 file changed, 15 insertions(+), 17 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index 46d2d43..ffadc8e 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -279,7 +279,7 @@ Use Gradle publish plugin to stage these artifacts on the Apache Nexus repositor
./gradlew publish -Prelease
-Review all staged artifacts. They should contain all relevant parts for each module, including `pom.xml`, jar, test jar, source, test source, javadoc, etc. Artifact names should follow [the existing format](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.beam%22) in which artifact name mirrors directory structure, e.g., `beam-sdks-java-io-kafka`. Carefully review any new artifacts.
+Review all staged artifacts. They should contain all relevant parts for each module, including `pom.xml`, jar, test jar, javadoc, etc. Artifact names should follow [the existing format](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.beam%22) in which artifact name mirrors directory structure, e.g., `beam-sdks-java-io-kafka`. Carefully review any new artifacts.
Close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Beam, version X, release candidate Y”.
@@ -293,24 +293,22 @@ Copy the source release to the dev repository of `dist.apache.org`.
1. Make a directory for the new release:
- mkdir beam/${VERSION}
- cd beam/${VERSION}
+ mkdir beam/${RELEASE}
+ cd beam/${RELEASE}
-1. Copy and rename the Beam source distribution, hashes, and GPG signature:
+1. Download source zip from GitHub:
- cp ${BEAM_ROOT}/target/apache-beam-${VERSION}-source-release.zip .
- cp ${BEAM_ROOT}/target/apache-beam-${VERSION}-source-release.zip.asc .
- cp ${BEAM_ROOT}/sdks/python/target/apache-beam-${VERSION}.zip apache-beam-${VERSION}-python.zip
+ wget https://github.com/apache/beam/archive/release-${RELEASE}.zip \
+ -O apache-beam-${RELEASE}-source-release.zip
-1. Create hashes for source files and sign the python source file file
+1. Create hashes and sign the source distribution:
- sha512sum apache-beam-${VERSION}-source-release.zip > apache-beam-${VERSION}-source-release.zip.sha512
- gpg --armor --detach-sig apache-beam-${VERSION}-python.zip
- sha512sum apache-beam-${VERSION}-python.zip > apache-beam-${VERSION}-python.zip.sha512
+ gpg --armor --detach-sig apache-beam-${RELEASE}-source-release.zip
+ sha512sum apache-beam-${RELEASE}-source-release.zip > apache-beam-${RELEASE}-source-release.zip.sha512
1. Add and commit all the files.
- svn add beam/${VERSION}
+ svn add beam/${RELEASE}
svn commit
1. Verify that files are [present](https://dist.apache.org/repos/dist/dev/beam).
@@ -338,14 +336,14 @@ candidate into the source tree of the website.
Add the new Javadoc to [SDK API Reference page]({{ site.baseurl }}/documentation/sdks/javadoc/) page, as follows:
* Unpack the Maven artifact `org.apache.beam:beam-sdks-java-javadoc` into some temporary location. Call this `${JAVADOC_TMP}`.
-* Copy the generated Javadoc into the website repository: `cp -r ${JAVADOC_TMP} src/documentation/sdks/javadoc/${VERSION}`.
+* Copy the generated Javadoc into the website repository: `cp -r ${JAVADOC_TMP} src/documentation/sdks/javadoc/${RELEASE}`.
* Set up the necessary git commands to account for the new and deleted files from the javadoc.
* Update the Javadoc link on this page to point to the new version (in `src/documentation/sdks/javadoc/current.md`).
#### Create Pydoc
Add the new Pydoc to [SDK API Reference page]({{ site.baseurl }}/documentation/sdks/pydoc/) page, as follows:
-* Copy the generated Pydoc into the website repository: `cp -r ${PYDOC_ROOT} src/documentation/sdks/pydoc/${VERSION}`.
+* Copy the generated Pydoc into the website repository: `cp -r ${PYDOC_ROOT} src/documentation/sdks/pydoc/${RELEASE}`.
* Remove `.doctrees` directory.
* Update the Pydoc link on this page to point to the new version (in `src/documentation/sdks/pydoc/current.md`).
@@ -454,9 +452,9 @@ Use the Apache Nexus repository to release the staged binary artifacts to the Ma
### Deploy Python artifacts to PyPI
1. Create a new release and upload the Python zip file for the new release using the [PyPI UI] (https://pypi.python.org/pypi/apache-beam)
-1. Alternatively, use the command line tool to upload the new release `twine upload apache-beam-${VERSION}.zip`
+1. Alternatively, use the command line tool to upload the new release `twine upload apache-beam-${RELEASE}.zip`
-Note: It is important to rename `apache-beam-${VERSION}-python.zip` to `apache-beam-${VERSION}.zip` before uploading, because PyPI expects a filename in the `<package-name>-<package-version>` format.
+Note: It is important to rename `apache-beam-${RELEASE}-python.zip` to `apache-beam-${RELEASE}.zip` before uploading, because PyPI expects a filename in the `<package-name>-<package-version>` format.
#### Deploy source release to dist.apache.org
@@ -466,7 +464,7 @@ Copy the source release from the `dev` repository to the `release` repository at
Create and push a new signed tag for the released version by copying the tag for the final release candidate, as follows:
- VERSION_TAG="v${VERSION}"
+ VERSION_TAG="v${RELEASE}"
git tag -s "$VERSION_TAG" "$RC_TAG"
git push github "$VERSION_TAG"
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 13/14: Update gradle publish with --no-parallel
--no-daemon
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit d9634716be5d28a898ebc5e5be506b6c16a85d5f
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Thu Jun 7 11:22:06 2018 -0700
Update gradle publish with --no-parallel --no-daemon
---
src/contribute/release-guide.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index 4c9c536..b2abf32 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -337,7 +337,7 @@ release tag to the origin repository (this would be the Apache Beam repo):
Use Gradle publish plugin to stage these artifacts on the Apache Nexus repository, as follows:
- ./gradlew publish -PisRelease
+ ./gradlew publish -PisRelease --no-parallel --no-daemon
Review all staged artifacts. They should contain all relevant parts for each module, including `pom.xml`, jar, test jar, javadoc, etc. Artifact names should follow [the existing format](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.beam%22) in which artifact name mirrors directory structure, e.g., `beam-sdks-java-io-kafka`. Carefully review any new artifacts.
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 01/14: Updating release guide to use Gradle commands.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit a48e1ec8db7458878add402e5f6e9cd969d663d3
Author: Pablo <pa...@google.com>
AuthorDate: Thu Apr 19 16:21:42 2018 -0700
Updating release guide to use Gradle commands.
---
src/contribute/release-guide.md | 55 ++++++++++++++++++++++-------------------
1 file changed, 29 insertions(+), 26 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index 76bdb12..3d6b5cc 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -189,30 +189,35 @@ Check out the version of the codebase from which you start the release. For a ne
Set up a few environment variables to simplify Maven commands that follow. (We use `bash` Unix syntax in this guide.)
- VERSION="1.2.3"
- NEXT_VERSION="1.2.4"
- BRANCH_NAME="release-${VERSION}"
- DEVELOPMENT_VERSION="${NEXT_VERSION}-SNAPSHOT"
+ RELEASE_VERSION=2.5.0
+ NEXT_VERSION_IN_BASE_BRANCH=2.6.0
+ BRANCH=release-${RELEASE}
Version represents the release currently underway, while next version specifies the anticipated next version to be released from that branch. Normally, 1.2.0 is followed by 1.3.0, while 1.2.3 is followed by 1.2.4.
-Use Maven release plugin to create the release branch and update the current branch to use the new development version. This command applies for the new major or minor version. (Warning: this command automatically pushes changes to the code repository.)
+**NOTE**: Only if you are doing an incremental/hotfix releasei (e.g. 2.5.1), please check out the previous release tag, before running the following instructions:
- mvn release:branch \
- -DbranchName=${BRANCH_NAME} \
- -DdevelopmentVersion=${DEVELOPMENT_VERSION}
+ BASE_RELEASE=2.5.0
+ RELEASE=2.5.1
+ NEXT_VERSION_IN_BASE_BRANCH=2.5.0
+ git checkout tags/${BASE_RELEASE}
-However, if you are doing an incremental/hotfix release, please run the following command after checking out the release tag of the release being patched.
+Create a new branch, and update version files in the master branch.
- mvn release:branch \
- -DbranchName=${BRANCH_NAME} \
- -DupdateWorkingCopyVersions=false \
- -DupdateBranchVersions=true \
- -DreleaseVersion="${VERSION}-SNAPSHOT"
+ git branch ${BRANCH}
+
+ # Now change the version in existing gradle files, and Python files
+ sed -i 's/'$RELEASE'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g' build_rules.gradle
+ sed -i 's/'$RELEASE'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g' gradle.properties
+ sed -i 's/'$RELEASE'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g' sdks/python/apache_beam/version.py
+
+ # Save changes in master branch
+ git add gradle.properties build_rules.gradle
+ git commit -m "Moving to ${NEXT_VERSION_IN_BASE_BRANCH}-SNAPSHOT on master branch."
Check out the release branch.
- git checkout ${BRANCH_NAME}
+ git checkout ${BRANCH}
The rest of this guide assumes that commands are run in the root of a repository on `${BRANCH_NAME}` with the above environment variables set.
@@ -258,22 +263,20 @@ The core of the release process is the build-vote-fix cycle. Each cycle produces
### Build and stage Java artifacts with Maven
-Set up a few environment variables to simplify Maven commands that follow. This identifies the release candidate being built. Start with `RC_NUM` equal to `1` and increment it for each candidate.
+Set up a few environment variables to simplify the commands that follow. These identify the release candidate being built, and the branch where you will stage files. Start with `RC_NUM` equal to `1` and increment it for each candidate.
+
+ RC_NUM=1
- RC_NUM="1"
- RC_TAG="v${VERSION}-RC${RC_NUM}"
-Use Maven release plugin to build the release artifacts, as follows:
+Use Gradle release plugin to build the release artifacts, as follows:
- mvn release:prepare \
- -Dresume=false \
- -DreleaseVersion=${VERSION} \
- -Dtag=${RC_TAG} \
- -DupdateWorkingCopyVersions=false
+ ./gradlew release -Prelease.newVersion=${RELEASE_VERSION}-SNAPSHOT \
+ -Prelease.releaseVersion=${RELEASE_VERSION}-RC${RC_NUM} \
+ -Prelease.useAutomaticVersion=true --info --no-daemon
-Use Maven release plugin to stage these artifacts on the Apache Nexus repository, as follows:
+Use Gradle publish plugin to stage these artifacts on the Apache Nexus repository, as follows:
- mvn release:perform
+ ./gradlew publish -Prelease
Review all staged artifacts. They should contain all relevant parts for each module, including `pom.xml`, jar, test jar, source, test source, javadoc, etc. Artifact names should follow [the existing format](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.beam%22) in which artifact name mirrors directory structure, e.g., `beam-sdks-java-io-kafka`. Carefully review any new artifacts.
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 03/14: Addressing comments. Improving commands.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 3c14234c7f69eb82bd69dd469f606b7963da086d
Author: Pablo <pa...@google.com>
AuthorDate: Fri Apr 20 11:13:19 2018 -0700
Addressing comments. Improving commands.
---
src/contribute/release-guide.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index e6a3792..46d2d43 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -190,7 +190,7 @@ Check out the version of the codebase from which you start the release. For a ne
Set up a few environment variables to simplify Maven commands that follow. (We use `bash` Unix syntax in this guide.)
- RELEASE_VERSION=2.5.0
+ RELEASE=2.5.0
NEXT_VERSION_IN_BASE_BRANCH=2.6.0
BRANCH=release-${RELEASE}
@@ -271,8 +271,8 @@ Set up a few environment variables to simplify the commands that follow. These i
Use Gradle release plugin to build the release artifacts, as follows:
- ./gradlew release -Prelease.newVersion=${RELEASE_VERSION}-SNAPSHOT \
- -Prelease.releaseVersion=${RELEASE_VERSION}-RC${RC_NUM} \
+ ./gradlew release -Prelease.newVersion=${RELEASE}-SNAPSHOT \
+ -Prelease.releaseVersion=${RELEASE}-RC${RC_NUM} \
-Prelease.useAutomaticVersion=true --info --no-daemon
Use Gradle publish plugin to stage these artifacts on the Apache Nexus repository, as follows:
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 08/14: Add more updates
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit bbc63f6c7c031437d282623032d9275699f01779
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Fri Jun 1 17:13:29 2018 -0700
Add more updates
---
src/contribute/release-guide.md | 89 +++++++++++++++++++++++++++++++++++++----
1 file changed, 81 insertions(+), 8 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index f49a9a4..cbec873 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -63,6 +63,15 @@ To prepare for each release, you should audit the project status in the JIRA iss
You need to have a GPG key to sign the release artifacts. Please be aware of the ASF-wide [release signing guidelines](https://www.apache.org/dev/release-signing.html). If you don’t have a GPG key associated with your Apache account, please create one according to the guidelines.
+Get more entropy for creating a GPG key
+
+ sudo apt-get install rng-tools
+ sudo rngd -r /dev/urandom
+
+Create a GPG key
+
+ gpg --full-generate-key
+
Determine your Apache GPG Key and Key ID, as follows:
gpg --list-keys
@@ -128,6 +137,8 @@ Release manager needs to have an account with PyPI. If you need one, [register a
When contributors resolve an issue in JIRA, they are tagging it with a release that will contain their changes. With the release currently underway, new issues should be resolved against a subsequent future release. Therefore, you should create a release item for this subsequent release, as follows:
+Attention: Only committer has permission to perform this.
+
1. In JIRA, navigate to the [`Beam > Administration > Versions`](https://issues.apache.org/jira/plugins/servlet/project-config/BEAM/versions).
1. Add a new release: choose the next minor version number compared to the one currently underway, select today’s date as the `Start Date`, and choose `Add`.
@@ -158,7 +169,52 @@ Adjust any of the above properties to the improve clarity and presentation of th
### Verify that a Release Build Works
-From a new workspace, run `git clean -fdx` to clean, and then `./gradlew -PisRelease build --no-parallel` to ensure that the build processes necessary for release are in good shape.
+Pre-installation for python build
+* Install pip
+
+ ```
+ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
+ python get-pip.py
+ ```
+* Install virtualenv
+
+ ```
+ pip install --upgrade virtualenv
+ ```
+* Cython
+
+ ```
+ sudo pip install cython
+ sudo apt-get install gcc
+ sudo apt-get install python-dev
+ ```
+Make sure your ```time``` alias to ```/usr/bin/time```, if not:
+
+```
+sudo apt-get install time
+alias time='/usr/bin/time'
+```
+
+Run gradle release build
+
+* Clean current workspace
+
+ ```
+ git clean -fdx
+ ./gradlew clean
+ ```
+
+* Unlock the secret key
+ ```
+ gpg --output ~/doc.sig --sign ~/.bashrc
+ ```
+
+* Run build command
+ ```
+ ./gradlew build -PisRelease --no-parallel --scan --stacktrace
+ ```
+
+From a new workspace, run `git clean -fdx` and `./gradlew clean` to clean, and then `./gradlew -PisRelease build --no-parallel` to ensure that the build processes necessary for release are in good shape.
### Update and Verify Javadoc
@@ -177,7 +233,9 @@ Javadoc to the Javadoc for other modules that Beam depends on.
the version number has changed, download a new version of the corresponding
`<module>-docs/package-list` file.
-### Create a release branch
+### Create a release branch in apache/beam repository
+
+Attention: Only committer has permission to create release branch in apache/beam.
Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the Apache code repository, and update version information on the original branch.
@@ -223,22 +281,26 @@ The rest of this guide assumes that commands are run in the root of a repository
### Update the Python SDK version
-In the release branch, update the Python SDK version to the release version (e.g. `1.2.3.dev` to `1.2.3`).
+Update [sdks/python/apache_beam/version.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/version.py) in both master branch and release branch.
+
+* In the master branch, change the Python SDK version to the next dev version(e.g, `2.5.0-dev` to `2.6.0-dev`).
+
+* In the release branch, update the Python SDK version to the release version(e.g. `2.5.0-dev` to `2.5.0`).
### Update release specific configurations
-1. Update archetypes:
- [example](https://github.com/apache/beam/commit/d375cfa126fd7be9eeeec34f39c2b9b856f324bf)
-2. Update runner specific configurations:
+Update runner specific configurations:
[example](https://github.com/apache/beam/commit/f572328ce23e70adee8001e3d10f1479bd9a380d)
### Start a snapshot build
-Start a build of [the nightly snapshot](https://builds.apache.org/view/A-D/view/Beam/job/beam_Release_NightlySnapshot/).
+Start a build of [the nightly snapshot](https://builds.apache.org/view/A-D/view/Beam/job/beam_Release_NightlySnapshot/) against master branch.
Some processes, including our archetype tests, rely on having a live SNAPSHOT of the current version
from the `master` branch. Once the release branch is cut, these SNAPSHOT versions are no longer found,
so builds will be broken until a new snapshot is available.
+Comment ```Run Gradle Publish``` in one pull request to trigger build.
+
### Checklist to proceed to the next step
1. Release Manager’s GPG key is published to `dist.apache.org`
@@ -259,12 +321,15 @@ so builds will be broken until a new snapshot is available.
The core of the release process is the build-vote-fix cycle. Each cycle produces one release candidate. The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized.
-### Build and stage Java artifacts with Maven
+### Build and stage Java artifacts with Gradle
Set up a few environment variables to simplify the commands that follow. These identify the release candidate being built, and the branch where you will stage files. Start with `RC_NUM` equal to `1` and increment it for each candidate.
RC_NUM=1
+Make sure your git config will maintain your account:
+
+ git config credential.helper store
Use Gradle release plugin to build the release artifacts, and push code and
release tag to the origin repository (this would be the Apache Beam repo):
@@ -283,6 +348,8 @@ Close the staging repository on Apache Nexus. When prompted for a description, e
### Stage source release on dist.apache.org
+Attention: Only committer has permissions to perform following steps.
+
Copy the source release to the dev repository of `dist.apache.org`.
1. If you have not already, check out the Beam section of the `dev` repository on `dist.apache.org` via Subversion. In a fresh directory:
@@ -313,6 +380,12 @@ Copy the source release to the dev repository of `dist.apache.org`.
### Build the Pydoc API reference
+Make sure you have ```tox``` installed:
+
+```
+pip install tox
+
+```
Create the Python SDK documentation using sphinx by running a helper script.
```
cd sdks/python && tox -e docs
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 09/14: More updates
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 207220b8c5ac69e2b8cf1011543f02a98de893cc
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Mon Jun 4 13:04:28 2018 -0700
More updates
---
src/contribute/release-guide.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index cbec873..a4a83e5 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -214,8 +214,6 @@ Run gradle release build
./gradlew build -PisRelease --no-parallel --scan --stacktrace
```
-From a new workspace, run `git clean -fdx` and `./gradlew clean` to clean, and then `./gradlew -PisRelease build --no-parallel` to ensure that the build processes necessary for release are in good shape.
-
### Update and Verify Javadoc
The build with `-PisRelease` creates the combined Javadoc for the release in `sdks/java/javadoc`.
@@ -279,18 +277,22 @@ Check out the release branch.
The rest of this guide assumes that commands are run in the root of a repository on `${BRANCH_NAME}` with the above environment variables set.
+### Update the beam version on master to the next dev version
+* [beam/build_rules.gradle](https://github.com/apache/beam/blob/master/build_rules.gradle): update value of 'version'(e.g, '2.5.0' to '2.6.0')
+* [beam/pom.xml](https://github.com/apache/beam/blob/master/pom.xml): update value of 'version' field(e.g, '2.5.0-SNAPSHOT' to '2.6.0-SNAPSHOT')
+
### Update the Python SDK version
Update [sdks/python/apache_beam/version.py](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/version.py) in both master branch and release branch.
* In the master branch, change the Python SDK version to the next dev version(e.g, `2.5.0-dev` to `2.6.0-dev`).
-
* In the release branch, update the Python SDK version to the release version(e.g. `2.5.0-dev` to `2.5.0`).
### Update release specific configurations
-Update runner specific configurations:
- [example](https://github.com/apache/beam/commit/f572328ce23e70adee8001e3d10f1479bd9a380d)
+Update Java runner specific configurations in release branch:
+* [beam/runners/google-cloud-dataflow-java/build.gradle](https://github.com/apache/beam/blob/master/runners/google-cloud-dataflow-java/build.gradle): change value of 'dataflow.container_version' to 'beam-release_version_number'(e.g, 'beam-master-20180601' to 'beam-2.5.0')
+* [beam/runners/google-cloud-dataflow-java/pom.xml](https://github.com/apache/beam/blob/master/runners/google-cloud-dataflow-java/pom.xml): change value of 'version' field (e.g, '2.5.0-SNAPSHOT' to '2.5.0')
### Start a snapshot build
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 11/14: Add instructions about how to stage python
binaries
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 167141b8db531fd2de8023933da5b5c404fa31a5
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Wed Jun 6 16:09:56 2018 -0700
Add instructions about how to stage python binaries
---
src/contribute/release-guide.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index b0fc7a1..eec7883 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -375,6 +375,28 @@ Copy the source release to the dev repository of `dist.apache.org`.
1. Verify that files are [present](https://dist.apache.org/repos/dist/dev/beam).
+### Stage python binaries on dist.apache.org
+
+Build python binaries in release branch in sdks/python dir.
+
+ python setup.py sdist --format=zip
+ cd dist
+ mv apache-beam-${RELEASE}.zip apache-beam-${RELEASE}-python.zip
+
+Create hashes and sign the binaries
+
+ gpg --armor --detach-sig apache-beam-${RELEASE}-python.zip
+ sha512sum apache-beam-${RELEASE}-python.zip > apache-beam-${RELEASE}-python.zip.sha512
+
+Staging binaries
+
+ svn co https://dist.apache.org/repos/dist/dev/beam
+ cd beam/${RELEASE}
+ svn add *
+ svn commit
+
+Verify that files are [present](https://dist.apache.org/repos/dist/dev/beam).
+
### Build the Pydoc API reference
Make sure you have ```tox``` installed:
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 05/14: Addressing TODOs
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 81c1aaedefd44a21b18d15dc3a7404d934c5ac02
Author: Pablo <pa...@google.com>
AuthorDate: Tue May 1 15:08:48 2018 -0700
Addressing TODOs
---
src/contribute/release-guide.md | 18 ++++++++----------
1 file changed, 8 insertions(+), 10 deletions(-)
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index ffadc8e..cbcf1ca 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -158,12 +158,11 @@ Adjust any of the above properties to the improve clarity and presentation of th
### Verify that a Release Build Works
-Run `mvn -Prelease clean install` to ensure that the build processes that are specific to that
-profile are in good shape.
+Run `./gradlew -PisRelease clean build` to ensure that the build processes that are specific to that profile are in good shape.
### Update and Verify Javadoc
-The build with `-Prelease` creates the combined Javadoc for the release in `sdks/java/javadoc`.
+The build with `-PisRelease` creates the combined Javadoc for the release in `sdks/java/javadoc`.
The file `sdks/java/javadoc/ant.xml` file contains a list of modules to include
in and exclude, plus a list of offline URLs that populate links from Beam's
@@ -209,11 +208,11 @@ Create a new branch, and update version files in the master branch.
# Now change the version in existing gradle files, and Python files
sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" build_rules.gradle
- sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" gradle.properties
- sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" sdks/python/apache_beam/version.py
+ sed -i -e "s/${RELEASE}/${NEXT_VERSION_IN_BASE_BRANCH}/g" gradle.properties
+ sed -i -e "s/${RELEASE}/${NEXT_VERSION_IN_BASE_BRANCH}/g" sdks/python/apache_beam/version.py
# Save changes in master branch
- git add gradle.properties build_rules.gradle
+ git add gradle.properties build_rules.gradle sdks/python/apache_beam/version.py
git commit -m "Moving to ${NEXT_VERSION_IN_BASE_BRANCH}-SNAPSHOT on master branch."
Check out the release branch.
@@ -224,8 +223,6 @@ The rest of this guide assumes that commands are run in the root of a repository
### Update the Python SDK version
-In the master branch, update Python SDK [version](https://github.com/apache/beam/blob/master/sdks/python/apache_beam/version.py) identifier to the next development version (e.g. `1.2.3.dev` to `1.3.0.dev`).
-
In the release branch, update the Python SDK version to the release version (e.g. `1.2.3.dev` to `1.2.3`).
### Update release specific configurations
@@ -269,7 +266,8 @@ Set up a few environment variables to simplify the commands that follow. These i
RC_NUM=1
-Use Gradle release plugin to build the release artifacts, as follows:
+Use Gradle release plugin to build the release artifacts, and push code and
+release tag to the origin repository (this would be the Apache Beam repo):
./gradlew release -Prelease.newVersion=${RELEASE}-SNAPSHOT \
-Prelease.releaseVersion=${RELEASE}-RC${RC_NUM} \
@@ -277,7 +275,7 @@ Use Gradle release plugin to build the release artifacts, as follows:
Use Gradle publish plugin to stage these artifacts on the Apache Nexus repository, as follows:
- ./gradlew publish -Prelease
+ ./gradlew publish -PisRelease
Review all staged artifacts. They should contain all relevant parts for each module, including `pom.xml`, jar, test jar, javadoc, etc. Artifact names should follow [the existing format](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.beam%22) in which artifact name mirrors directory structure, e.g., `beam-sdks-java-io-kafka`. Carefully review any new artifacts.
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.