announce-a-release.bash

#!/bin/bash

# Announces a release after artifacts have been built:
#
# - Publishes release notes to GitHub
# - Announces in the #announce stream of Zulip
# - Adds a note about the release to LWIP
#
# Tools required in the environment that runs this:
#
# - bash
# - changelog-tool
# - curl
# - git
# - jq

set -o errexit

# Verify ENV is set up correctly
# We validate all that need to be set in case, in an absolute emergency,
# we need to run this by hand. Otherwise the GitHub actions environment should
# provide all of these if properly configured
if [[ -z "${GITHUB_REF}" ]]; then
  echo -e "\e[31mThe release tag needs to be set in GITHUB_REF."
  echo -e "\e[31mThe tag should be in the following GitHub specific form:"
  echo -e "\e[31m    /refs/tags/announce-X.Y.Z"
  echo -e "\e[31mwhere X.Y.Z is the version we are announcing"
  echo -e "\e[31mExiting.\e[0m"
  exit 1
fi

if [[ -z "${GITHUB_REPOSITORY}" ]]; then
  echo -e "\e[31mName of this repository needs to be set in GITHUB_REPOSITORY."
  echo -e "\e[31mShould be in the form OWNER/REPO, for example:"
  echo -e "\e[31m     ponylang/ponyup"
  echo -e "\e[31mExiting.\e[0m"
  exit 1
fi

if [[ -z "${RELEASE_TOKEN}" ]]; then
  echo -e "\e[31mA personal access token needs to be set in RELEASE_TOKEN."
  echo -e "\e[31mIt should not be secrets.GITHUB_TOKEN. It has to be a"
  echo -e "\e[31mpersonal access token otherwise next steps in the release"
  echo -e "\e[31mprocess WILL NOT trigger."
  echo -e "\e[31mPersonal access tokens are in the form:"
  echo -e "\e[31m     TOKEN"
  echo -e "\e[31mfor example:"
  echo -e "\e[31m     1234567890"
  echo -e "\e[31mExiting.\e[0m"
  exit 1
fi

if [[ -z "${SLACK_TOKEN}" ]]; then
  echo -e "\e[31mA Slack access token needs to be set in SLACK_TOKEN."
  echo -e "Exiting.\e[0m"
  exit 1
fi

# no unset variables allowed from here on out
# allow above so we can display nice error messages for expected unset variables
set -o nounset

PUSH_TO="https://${RELEASE_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"

echo -e $GITHUB_REF

# Extract version from tag reference
# Tag ref version: "refs/tags/release-1.0.0"
# Version: "1.0.0"
VERSION="${GITHUB_REF/refs\/tags\/release-/}"

git pull

# Prepare release notes
echo -e "\e[34mPreparing to update GitHub release notes...\e[0m"
release_notes=""
if test -f ".release-notes/next-release.md"; then
  echo -e "\e[34mnext-release.md found. Adding entries to release notes.\e[0m"
  fc=$(<".release-notes/next-release.md")
  echo -e $fc
  release_notes="${fc}"
else
  echo -e "\e[34mNo next-release.md found. Only using changelog entries\e[0m"
fi

echo -e $VERSION
changelog=$(changelog-tool get "${VERSION}")
echo -e $changelog
body="${release_notes}${changelog}"

jsontemplate="
{
  \"tag_name\":\$version,
  \"name\":\$version,
  \"body\":\$body
}
"

json=$(jq -n \
--arg version "$VERSION" \
--arg body "$body" \
"${jsontemplate}")

# Upload release notes
echo -e "\e[34mUploading release notes...\e[0m"
result=$(curl -s -X POST "https://api.github.com/repos/${GITHUB_REPOSITORY}/releases" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -u "${RELEASE_TOKEN}" \
  --data "${json}")

rslt_scan=$(echo "${result}" | jq -r '.id')
if [ "$rslt_scan" != null ]; then
  echo -e "\e[34mRelease notes uploaded\e[0m"
else
  echo -e "\e[31mUnable to upload release notes, here's the curl output..."
  echo -e "\e[31m${result}\e[0m"
  exit 1
fi

# Send announcement to Slack
message="
Version ${VERSION} of ${GITHUB_REPOSITORY} has been released.

See the release notes https://github.com/${GITHUB_REPOSITORY}/releases/tag/${VERSION} for more details.
"

curl -F token="${SLACK_TOKEN}" -F channel="alerts-releases" -F text="${message}" https://slack.com/api/chat.postMessage

# delete announce-VERSION tag
#echo -e "\e[34mDeleting no longer needed remote tag announce-${VERSION}\e[0m"
#git push --delete "${PUSH_TO}" "announce-${VERSION}"

# This doesn't account for the default branch changing commit. It assumes we
# are HEAD or can otherwise push without issue.
git checkout "${INPUT_DEFAULT_BRANCH}"
git pull

# rotate next-release.md content
if test -f ".release-notes/next-release.md"; then
  echo -e "\e[34mRotating release notes\e[0m"
  mv ".release-notes/next-release.md" ".release-notes/${VERSION}.md"
  touch ".release-notes/next-release.md"
  git add .release-notes/*
  git commit -m "Rotate release notes as part of ${VERSION} release"
  echo -e "\e[34mPushing release notes changes\e[0m"
  git push "${PUSH_TO}" "${INPUT_DEFAULT_BRANCH}"
fi