[cassandra-builds] 01/01: Add information about variables required for a build

[if...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ifesdjeen pushed a commit to branch release-info
in repository https://gitbox.apache.org/repos/asf/cassandra-builds.git

commit 24088aea938d41d419b4a3199ffbc8871f6a911a
Author: Alex Petrov <ol...@gmail.com>
AuthorDate: Fri Jul 23 11:01:15 2021 +0200

    Add information about variables required for a build
---
 README.md                            | 11 +++++++++++
 cassandra-release/finish_release.sh  |  9 +++++++--
 cassandra-release/prepare_release.sh |  9 ++++++++-
 3 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index de88ae6..3bf3395 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,17 @@
     * `cassandra-release/`
     * `docker/`
 
+## Releasing Cassanda
+
+Please refer to the following documents for more details about releases:
+
+  * [Release Process](https://cassandra.apache.org/doc/latest/development/release_process.html)
+  * [Release Managers Onboarding](https://cwiki.apache.org/confluence/display/CASSANDRA/Release+Managers+Onboarding)
+
+Prior to release, make sure to edit:
+  * `cassandra-release/finish_release.sh` to set `ARTIFACTORY_API_KEY`
+  * `cassandra-release/prepare_release.sh` to set `gpg_key`
+
 ## Building packages
 
 1. Create build images containing the build tool-chain, Java and an Apache Cassandra git working directory
diff --git a/cassandra-release/finish_release.sh b/cassandra-release/finish_release.sh
index 295a891..bb0173f 100755
--- a/cassandra-release/finish_release.sh
+++ b/cassandra-release/finish_release.sh
@@ -4,8 +4,13 @@
 
 asf_username="$USER"
 
-# get your jfrog artifactory API Key from https://apache.jfrog.io/ui/admin/artifactory/user_profile
-ARTIFACTORY_API_KEY="XXXXXXXX"
+if [ -z "$ARTIFACTORY_API_KEY" ]; then
+    ARTIFACTORY_API_KEY="XXXXXXXX"
+fi
+
+if [ "$ARTIFACTORY_API_KEY" = "XXXXXXXX" ]; then
+    exit -e "Get your jfrog artifactory API Key from https://apache.jfrog.io/ui/admin/artifactory/user_profile and set ARTIFACTORY_API_KEY to it"
+fi
 
 # The name of remote for the asf remote in your git repo
 git_asf_remote="origin"
diff --git a/cassandra-release/prepare_release.sh b/cassandra-release/prepare_release.sh
index de60d9b..031c550 100755
--- a/cassandra-release/prepare_release.sh
+++ b/cassandra-release/prepare_release.sh
@@ -3,7 +3,14 @@
 ##### TO EDIT #####
 
 asf_username="$USER"
-gpg_key="XXXXXXXX"
+
+if [ -z "$gpg_key" ]; then
+    gpg_key="XXXXXXXX"
+fi
+
+if [ "$gpg_key" = "XXXXXXXX" ]; then
+    exit -e "Gpg key is unset. Pleae set gpg_key variable."
+fi
 
 # The name of remote for the asf remote in your git repo
 git_asf_remote="origin"

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org