[SPARK-24372][build] Add scripts to help with preparing releases. #21515
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You 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. | ||
| # | ||
|
|
||
| set -e | ||
| SELF=$(cd $(dirname $0) && pwd) | ||
| . "$SELF/release-util.sh" | ||
|
|
||
| WORKDIR= | ||
| IMGTAG=latest | ||
| JAVA= | ||
| while getopts "d:j:nt:" opt; do | ||
| case $opt in | ||
| d) WORKDIR="$OPTARG" ;; | ||
| n) DRY_RUN=1 ;; | ||
| t) IMGTAG="$OPTARG" ;; | ||
| j) JAVA="$OPTARG" ;; | ||
| ?) error "Invalid option: $OPTARG" ;; | ||
| esac | ||
| done | ||
|
|
||
| if [ -z "$WORKDIR" ] || [ ! -d "$WORKDIR" ]; then | ||
| error "Work directory (-d) must be defined and exist." | ||
| fi | ||
|
|
||
| if [ -d "$WORKDIR/output" ]; then | ||
| read -p "Output directory already exists. Overwrite and continue? [y/n] " ANSWER | ||
| if [ "$ANSWER" != "y" ]; then | ||
| error "Exiting." | ||
| fi | ||
| fi | ||
|
|
||
| cd "$WORKDIR" | ||
| rm -rf "$WORKDIR/output" | ||
| mkdir "$WORKDIR/output" | ||
|
|
||
| get_release_info | ||
|
|
||
| # Place all RM scripts and necessary data in a local directory that must be defined in the command | ||
| # line. This directory is mounted into the image. | ||
| for f in "$SELF"/*; do | ||
| if [ -f "$f" ]; then | ||
| cp "$f" "$WORKDIR" | ||
| fi | ||
| done | ||
| GPG_KEY_FILE="$WORKDIR/gpg.key" | ||
| fcreate_secure "$GPG_KEY_FILE" | ||
| $GPG --export-secret-key --armor "$GPG_KEY" > "$GPG_KEY_FILE" | ||
|
|
||
| run_silent "Building spark-rm image with tag $IMGTAG..." "docker-build.log" \ | ||
| docker build -t "spark-rm:$IMGTAG" --build-arg UID=$UID "$SELF/spark-rm" | ||
|
Contributor
There was a problem hiding this comment. So we need to do
Contributor
There was a problem hiding this comment. got it. This is a system variable. So we can't run this script with root user... |
||
|
|
||
| # Write the release information to a file with environment variables to be used when running the | ||
| # image. | ||
| ENVFILE="$WORKDIR/env.list" | ||
| fcreate_secure "$ENVFILE" | ||
|
|
||
| function cleanup { | ||
| rm -f "$ENVFILE" | ||
| rm -f "$GPG_KEY_FILE" | ||
| } | ||
|
|
||
| trap cleanup EXIT | ||
|
|
||
| cat > $ENVFILE <<EOF | ||
| DRY_RUN=$DRY_RUN | ||
| SKIP_TAG=$SKIP_TAG | ||
| RUNNING_IN_DOCKER=1 | ||
| GIT_BRANCH=$GIT_BRANCH | ||
| NEXT_VERSION=$NEXT_VERSION | ||
| RELEASE_VERSION=$RELEASE_VERSION | ||
| RELEASE_TAG=$RELEASE_TAG | ||
| GIT_REF=$GIT_REF | ||
| SPARK_PACKAGE_VERSION=$SPARK_PACKAGE_VERSION | ||
| ASF_USERNAME=$ASF_USERNAME | ||
| GIT_NAME=$GIT_NAME | ||
| GIT_EMAIL=$GIT_EMAIL | ||
| GPG_KEY=$GPG_KEY | ||
| ASF_PASSWORD=$ASF_PASSWORD | ||
| GPG_PASSPHRASE=$GPG_PASSPHRASE | ||
| EOF | ||
|
|
||
| JAVA_VOL= | ||
| if [ -n "$JAVA" ]; then | ||
| echo "JAVA_HOME=/opt/spark-java" >> $ENVFILE | ||
| JAVA_VOL="--volume $JAVA:/opt/spark-java" | ||
| fi | ||
|
|
||
| echo "Building $RELEASE_TAG; output will be at $WORKDIR/output" | ||
| docker run -ti \ | ||
| --env-file "$ENVFILE" \ | ||
| --volume "$WORKDIR:/opt/spark-rm" \ | ||
| $JAVA_VOL \ | ||
| "spark-rm:$IMGTAG" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You 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. | ||
| # | ||
|
|
||
| SELF=$(cd $(dirname $0) && pwd) | ||
| . "$SELF/release-util.sh" | ||
|
|
||
| while getopts "bn" opt; do | ||
|
Contributor
There was a problem hiding this comment. it would be nice to have a high level description in the script just saying this does a release which does things like tag, build, etc and pushes things to the asf spark repo. |
||
| case $opt in | ||
| b) GIT_BRANCH=$OPTARG ;; | ||
| n) DRY_RUN=1 ;; | ||
| ?) error "Invalid option: $OPTARG" ;; | ||
| esac | ||
| done | ||
|
|
||
| if [ "$RUNNING_IN_DOCKER" = "1" ]; then | ||
| # Inside docker, need to import the GPG key stored in the current directory. | ||
| echo $GPG_PASSPHRASE | $GPG --passphrase-fd 0 --import "$SELF/gpg.key" | ||
|
|
||
| # We may need to adjust the path since JAVA_HOME may be overridden by the driver script. | ||
| if [ -n "$JAVA_HOME" ]; then | ||
| export PATH="$JAVA_HOME/bin:$PATH" | ||
| else | ||
| # JAVA_HOME for the openjdk package. | ||
| export JAVA_HOME=/usr | ||
| fi | ||
| else | ||
| # Outside docker, need to ask for information about the release. | ||
| get_release_info | ||
| fi | ||
|
|
||
| if [ $SKIP_TAG = 0 ]; then | ||
| maybe_run "Creating release tag $RELEASE_TAG..." "tag.log" \ | ||
| "$SELF/release-tag.sh" | ||
| else | ||
| echo "Skipping tag creation for $RELEASE_TAG." | ||
| fi | ||
|
|
||
| run_silent "Building Spark..." "build.log" \ | ||
| "$SELF/release-build.sh" package | ||
| run_silent "Building documentation..." "docs.log" \ | ||
| "$SELF/release-build.sh" docs | ||
| maybe_run "Publishing release" "publish.log" \ | ||
| "$SELF/release-build.sh" publish-release | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even if rat doesn't check, isn't vote.tmpl packaged into the source release this way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for example,
.gitis removed from release here https://github.com/apache/spark/blob/master/dev/create-release/release-build.sh#L157There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you saying this file should not be packaged in the source release? Not sure I see why that would be the case. There's a lot of stuff in
.rat-excludesthat is still packaged.