mattf-apache commented on a change in pull request #1643:
URL: https://github.com/apache/hbase/pull/1643#discussion_r420508959



##########
File path: dev-support/create-release/release-build.sh
##########
@@ -20,114 +20,180 @@
 trap cleanup EXIT
 
 # Source in utils.
-SELF=$(cd $(dirname $0) && pwd)
+SELF="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+# shellcheck source=SCRIPTDIR/release-util.sh
 . "$SELF/release-util.sh"
 
 # Print usage and exit.
 function exit_with_usage {
-  cat << EOF
-Usage: release-build.sh <build|publish-snapshot|publish-release>
-Creates build deliverables from a tag/commit.
-Arguments:
- build             Create binary packages and commit to 
dist.apache.org/repos/dist/dev/hbase/
- publish-snapshot  Publish snapshot release to Apache snapshots
- publish-release   Publish a release to Apache release repo
-
-All other inputs are environment variables:
- GIT_REF - Release tag or commit to build from
- PACKAGE_VERSION - Release identifier in top level package directory (e.g. 
2.1.2RC1)
- VERSION - (optional) Version of project being built (e.g. 2.1.2)
- ASF_USERNAME - Username of ASF committer account
- ASF_PASSWORD - Password of ASF committer account
- GPG_KEY - GPG key used to sign release artifacts
- GPG_PASSPHRASE - Passphrase for GPG key
- PROJECT - The project to build. No default.
-
-Set REPO environment to full path to repo to use
-to avoid re-downloading dependencies on each run.
+  cat <<'EOF'
+Usage: release-build.sh <tag|publish-dist|publish-snapshot|publish-release>
+Creates release deliverables from a tag or commit.
+Argument: one of 'tag', 'publish-dist', 'publish-snapshot', or 
'publish-release'
+  tag               Prepares for release on specified git branch: Set release 
version,
+                    update CHANGES and RELEASENOTES, create release tag,
+                    increment version for ongoing dev, and publish to Apache 
git repo.
+  publish-dist      Build and publish distribution packages (tarballs) to 
Apache dist repo
+  publish-snapshot  Build and publish maven artifacts snapshot release to 
Apache snapshots repo
+  publish-release   Build and publish maven artifacts release to Apache 
release repo, and

Review comment:
       What one should do to run a release candidate, is invoke 
`do-release-docker.sh` (preferably) or `do-release.sh` (if there's a reason not 
to use docker).  I agree with your comments here and in the next item below, 
that this script must clearly be documented as NOT the entrance script.  And 
yet, the many env variables that get passed around as inter-script 
communication do need to be documented somewhere.  Let me see if I can move 
them to `do-release.sh`, and make the comments and the README more useful.
   
   




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to