-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an action to generate metadata for dev deploys from
env.GITHUB_* (
#21) * Add an action to generate dev deploy metadata from env.GITHUB_* * Use bash -u flag to catch unhandled unset vars * Make version check accept vMAJOR, vMAJOR.MINOR or vMAJOR.MINOR.PATCH * Make prefix dynamic. Defaults to repo basename, with an optional input for override.
- Loading branch information
Showing
5 changed files
with
180 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,149 @@ | ||
| #!/bin/bash | ||
| # Copyright (c) 2018-2022 The MobileCoin Foundation | ||
| # | ||
| # Generate metadata for dev deploy workflows. | ||
|
|
||
| set -eu | ||
|
|
||
| export TMPDIR=".tmp" | ||
|
|
||
| is_set() | ||
| { | ||
| var_name="${1}" | ||
|
|
||
| if [[ -z "${!var_name}" ]]; then | ||
| echo "${var_name} is not set." >&2 | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| normalize_ref_name() | ||
| { | ||
| # Remove prefix, convert delimiters to dashes, and strip trailing dashes. | ||
| echo "${1}" | sed -Ee 's!^(feature|release)/!!' | sed -e 's![._/]!-!g' | sed -e 's!-*$!!' | ||
| } | ||
|
|
||
| base_prefix() | ||
| { | ||
| basename "${GITHUB_REPOSITORY:-$PWD}" | ||
| } | ||
|
|
||
| # Check for github reference variables. | ||
| is_set GITHUB_REF_NAME | ||
| is_set GITHUB_REF_TYPE | ||
| is_set GITHUB_RUN_NUMBER | ||
| is_set GITHUB_SHA | ||
| is_set GITHUB_OUTPUT | ||
|
|
||
| # OK if INPUT_PREFIX and GITHUB_REPOSITORY are unset. | ||
| namespace_prefix="$(normalize_ref_name ${INPUT_PREFIX:-$(base_prefix)})" | ||
| namespace_prefix="${namespace_prefix:-mc}" | ||
| # Make sure prefix is no longer than 10 chars, to leave room | ||
| # in the 63-char limit on k8s namespaces. | ||
| if [[ ${#namespace_prefix} -gt 10 ]] | ||
| then | ||
| namespace_prefix="${namespace_prefix:0:10}" | ||
| fi | ||
|
|
||
| sha="sha-${GITHUB_SHA:0:8}" | ||
|
|
||
| # Set branch name. Where we get this ref is different for branch, pull_request or delete event | ||
| branch="${GITHUB_REF_NAME}" | ||
|
|
||
| # Override branch name with head when event is a PR | ||
| if [[ -n "${GITHUB_HEAD_REF:-}" ]] | ||
| then | ||
| branch="${GITHUB_HEAD_REF}" | ||
| fi | ||
|
|
||
| # Override branch with delete ref if set. | ||
| if [[ -n "${DELETE_REF_NAME:-}" ]] | ||
| then | ||
| branch="${DELETE_REF_NAME}" | ||
| fi | ||
|
|
||
| case "${GITHUB_REF_TYPE}" in | ||
| tag) | ||
| # check for valid tag and set outputs | ||
| version="${GITHUB_REF_NAME}" | ||
| if [[ ! "${version}" =~ ^v[0-9]+(\.[0-9]+)*.* ]] | ||
| then | ||
| echo "GitHub Tag ${version} is not valid semver." | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ "${version}" =~ - ]] | ||
| then | ||
| echo "Found pre-release tag." | ||
| # set artifact tag | ||
| tag="${version}" | ||
| else | ||
| echo "Found release tag." | ||
| # set artifact tag | ||
| tag="${version}-dev" | ||
| fi | ||
|
|
||
| # Set docker metadata action compatible tag. Short tag + metadata tag. | ||
| docker_tag=$(cat << EOF | ||
| type=raw,value=${tag},priority=20 | ||
| type=raw,value=${tag}.${GITHUB_RUN_NUMBER}.${sha},priority=10 | ||
| EOF | ||
| ) | ||
|
|
||
| normalized_tag=$(normalize_ref_name "${tag}") | ||
| namespace="${namespace_prefix}-${normalized_tag}" | ||
| ;; | ||
| # Branches and pull requests will set type as branch. | ||
| # Don't filter on "valid" branches, rely on workflows to filter out their accepted events. | ||
| branch) | ||
| # All branch builds will just have a "dummy" tag. | ||
| version="v0" | ||
|
|
||
| echo "Clean up branch. Remove feature|release prefix and replace ._/ with -" | ||
| normalized_branch="$(normalize_ref_name "${branch}")" | ||
|
|
||
| # Check and truncate branch name if total tag length exceeds the 63 character K8s label value limit. | ||
| label_limit=63 | ||
| version_len=${#version} | ||
| sha_len=${#sha} | ||
| run_number_len=${#GITHUB_RUN_NUMBER} | ||
| # number of separators in tag | ||
| dots=3 | ||
|
|
||
| cutoff=$((label_limit - version_len - sha_len - run_number_len - dots)) | ||
|
|
||
| if [[ ${#normalized_branch} -gt ${cutoff} ]] | ||
| then | ||
| cut_branch=$(echo "${normalized_branch}" | cut -c -${cutoff}) | ||
| echo "Your branch name ${normalized_branch} + metadata exceeds the maximum length for K8s identifiers, truncating to ${cut_branch}" | ||
| normalized_branch="${cut_branch}" | ||
| fi | ||
|
|
||
| echo "Before: '${branch}'" | ||
| echo "After: '${normalized_branch}'" | ||
|
|
||
| # Set artifact tag | ||
| tag="${version}-${normalized_branch}.${GITHUB_RUN_NUMBER}.${sha}" | ||
| # Set docker metadata action compatible tag | ||
| docker_tag="type=raw,value=${tag}" | ||
| # Set namespace from normalized branch value | ||
| namespace="${namespace_prefix}-${normalized_branch}" | ||
| ;; | ||
| *) | ||
| echo "${GITHUB_REF_TYPE} is an unknown GitHub Reference Type" | ||
| exit 1 | ||
| ;; | ||
| esac | ||
|
|
||
| # Set GHA output vars | ||
| cat <<EOO >> "${GITHUB_OUTPUT}" | ||
| version=${version} | ||
| namespace=${namespace} | ||
| sha=${sha} | ||
| tag=${tag} | ||
| docker_tag<<EOF | ||
| ${docker_tag} | ||
| EOF | ||
| EOO | ||
|
|
||
| cat "${GITHUB_OUTPUT}" |