From 9afe6f3e5b288d9d5d431e3032b443f95b548ada Mon Sep 17 00:00:00 2001
From: Adriano Cunha <adrcunha@google.com>
Date: Tue, 30 Oct 2018 11:14:32 -0700
Subject: [PATCH] Automate the creation of versioned releases

`test-infra` is updated to the latest version to include the required infrastructure.

Bonuses:
* documented the contents of the `hack` directory;
* documented how to use the `release.sh` script;
---
 hack/README.md  |  9 +++++++
 hack/release.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++
 hack/release.sh |  4 ++-
 3 files changed, 84 insertions(+), 1 deletion(-)
 create mode 100644 hack/README.md
 create mode 100644 hack/release.md

diff --git a/hack/README.md b/hack/README.md
new file mode 100644
index 00000000..252a4f84
--- /dev/null
+++ b/hack/README.md
@@ -0,0 +1,9 @@
+# Assorted scripts for development
+
+This directory contains several scripts useful in the development process of Knative Build.
+
+* `boilerplate/add-boilerplate.sh` Adds license boilerplate to *txt* or *go* files in a directory, recursively.
+* `release.sh` Creates a new [release](release.md) of Knative Build.
+* `update-codegen.sh` Updates auto-generated client libraries.
+* `update-deps.sh` Updates Go dependencies.
+* `verify-codegen.sh` Verifies that auto-generated client libraries are up-to-date.
diff --git a/hack/release.md b/hack/release.md
new file mode 100644
index 00000000..e72a4ba6
--- /dev/null
+++ b/hack/release.md
@@ -0,0 +1,72 @@
+# Creating a new Knative Build release
+
+The `release.sh` script automates the creation of Knative Build releases,
+either nightly or versioned ones.
+
+By default, the script creates a nightly release but does not publish anywhere.
+
+## Common flags for cutting releases
+
+The following flags affect the behavior of the script, no matter the type of
+the release.
+
+* `--skip-tests` Do not run tests before building the release. Otherwise,
+build, unit and end-to-end tests are run and they all must pass for the
+release to be built.
+* `--tag-release`, `--notag-release` Tag (or not) the generated images
+with either `vYYYYMMDD-<commit_short_hash>` (for nightly releases) or
+`vX.Y.Z` for versioned releases. *For versioned releases, a tag is always
+added.*
+* `--publish`, `--nopublish` Whether the generated images should be published
+to a GCR, and the generated manifests written to a GCS bucket or not. If yes,
+the destination GCR is defined by the environment variable
+`$BUILD_RELEASE_GCR` (defaults to `gcr.io/knative-releases`) and the
+destination GCS bucket is defined by the environment variable
+`$BUILD_RELEASE_GCS` (defaults to `knative-releases/build`). If no, the
+images will be pushed to the `ko.local` registry, and the manifests written
+to the local disk only (in the repository root directory).
+
+## Creating nightly releases
+
+Nightly releases are built against the current git tree. The behavior of the
+script is defined by the common flags. You must have write access to the GCR
+and GCS bucket the release will be pushed to, unless `--nopublish` is used.
+
+Examples:
+
+```bash
+# Create and publish a nightly, tagged release.
+./hack/release.sh --publish --tag-release
+
+# Create release, but don't test, publish or tag it.
+./hack/release.sh --skip-tests --nopublish --notag-release
+```
+
+## Creating versioned releases
+
+*Note: only Knative admins can create versioned releases.*
+
+To specify a versioned release to be cut, you must use the `--version` flag.
+Versioned releases are usually built against a branch in the Knative Build
+repository, specified by the `--branch` flag. 
+
+* `--version` Defines the version of the release, and must be in the form
+`X.Y.Z`, where X, Y and Z are numbers.
+* `--branch` Defines the branch in Knative Build repository from which the
+release will be built. If not passed, the `master` branch at HEAD will be
+used. This branch must be created before the script is executed, and must be
+in the form `release-X.Y`, where X and Y must match the numbers used in the
+version passed in the `--version` flag. This flag has no effect unless
+`--version` is also passed.
+* `--release-notes` Points to a markdown file containing a description of the
+release. This is optional but highly recommended. It has no effect unless
+`--version` is also passed.
+
+If this is the first time you're cutting a versioned release, you'll be prompted
+for your GitHub username, password, and possibly 2-factor authentication
+challenge before the release is published.
+
+The release will be published in the *Releases* page of the Knative Build
+repository, with the title *Knative Build release vX.Y.Z* and the given
+release notes. It will also be tagged *vX.Y.Z* (both on GitHub and as a git
+annotated tag).
diff --git a/hack/release.sh b/hack/release.sh
index f24f8968..1c3cb647 100755
--- a/hack/release.sh
+++ b/hack/release.sh
@@ -30,7 +30,7 @@ readonly OUTPUT_YAML=release.yaml
 
 # Script entry point
 
-parse_flags $@
+initialize $@
 
 set -o errexit
 set -o pipefail
@@ -71,6 +71,8 @@ docker push ${BUILD_BASE_GCR}
 echo "Publishing ${OUTPUT_YAML}"
 publish_yaml ${OUTPUT_YAML} ${BUILD_RELEASE_GCS} ${TAG}
 
+branch_release "Knative Build" ${OUTPUT_YAML}
+
 echo "New release published successfully"
 
 # TODO(mattmoor): Create other aliases?