|
| 1 | +#!/usr/bin/env bash |
| 2 | +set -euo pipefail |
| 3 | +# build_release_notes.sh |
| 4 | +# Generates release notes combining annotated tag message and CHANGELOG.md section. |
| 5 | +# Usage: build_release_notes.sh <tag> <repo_owner> <repo_name> <commit_sha> <github_server_url> |
| 6 | +# Outputs markdown to STDOUT. |
| 7 | + |
| 8 | +TAG=${1:?tag required} |
| 9 | +REPO_OWNER=${2:?owner required} |
| 10 | +REPO_NAME=${3:?name required} |
| 11 | +TAG_COMMIT=${4:?commit sha required} |
| 12 | +GITHUB_SERVER_URL=${5:-https://github.com} |
| 13 | + |
| 14 | +# Normalize versions (strip leading v) |
| 15 | +# VERSION_FULL keeps suffixes like -rc1, VERSION_CORE strips them |
| 16 | +VERSION_FULL=$(echo "$TAG" | sed -E 's/^v//') |
| 17 | +VERSION_CORE=$(echo "$VERSION_FULL" | sed -E 's/^([0-9]+(\.[0-9]+)*).*/\1/') |
| 18 | + |
| 19 | +# Get tag message. Try annotated tag contents first, then fall back to the tagged commit message |
| 20 | +# but only if the tag actually exists. If the tag name doesn't resolve to a tag ref, do nothing. |
| 21 | +TAG_MESSAGE="" |
| 22 | +# Check whether the tag ref exists |
| 23 | +if git rev-parse --verify --quiet "refs/tags/${TAG}" >/dev/null 2>&1; then |
| 24 | + # Try annotated tag contents (works for annotated tags) |
| 25 | + TAG_MESSAGE=$(git for-each-ref --format='%(contents)' "refs/tags/${TAG}" 2>/dev/null || true) |
| 26 | + |
| 27 | + # If empty, try to read tag object (cat-file) - may include annotation |
| 28 | + if [ -z "${TAG_MESSAGE}" ]; then |
| 29 | + TAG_MESSAGE=$(git cat-file -p "refs/tags/${TAG}" 2>/dev/null | sed -n '1,/^$/p' || true) |
| 30 | + fi |
| 31 | + |
| 32 | + # If still empty, fall back to commit message of the tagged commit (works for lightweight tags) |
| 33 | + if [ -z "${TAG_MESSAGE}" ]; then |
| 34 | + if git rev-parse "${TAG}^{commit}" >/dev/null 2>&1; then |
| 35 | + TAG_MESSAGE=$(git show -s --format='%B' "${TAG}^{commit}" 2>/dev/null || true) |
| 36 | + else |
| 37 | + TAG_MESSAGE=$(git show -s --format='%B' "${TAG}" 2>/dev/null || true) |
| 38 | + fi |
| 39 | + fi |
| 40 | +else |
| 41 | + # Tag reference does not exist; leave tag message empty |
| 42 | + TAG_MESSAGE="" |
| 43 | +fi |
| 44 | + |
| 45 | +# Remove potential trailing whitespace in tag message |
| 46 | +TAG_MESSAGE=$(printf '%s' "${TAG_MESSAGE}" | sed -E ':a; /\n$/ {N; ba}; s/[[:space:]]+$//') |
| 47 | +# Remove potential trailing whitespace in tag message |
| 48 | +TAG_MESSAGE=$(printf '%s' "${TAG_MESSAGE}" | sed -E ':a; /\n$/ {N; ba}; s/[[:space:]]+$//') |
| 49 | + |
| 50 | +# Extract the section from CHANGELOG.md belonging to this version |
| 51 | +CHANGELOG_CONTENT="" |
| 52 | +if git show "${TAG_COMMIT}:CHANGELOG.md" > /tmp/CHANGELOG_ALL 2>/dev/null; then |
| 53 | + # Grab section starting after heading line matching version until next heading |
| 54 | + # Try full version first (e.g., 1.0.0-rc1), then fall back to core (e.g., 1.0.0) |
| 55 | + EXTRACTED="" |
| 56 | + for try_ver in "${VERSION_FULL}" "${VERSION_CORE}"; do |
| 57 | + EXTRACTED=$(awk -v ver="${try_ver}" ' |
| 58 | + BEGIN{found=0} |
| 59 | + $0 ~ "^##[[:space:]]*\\[" ver "\\]" {found=1; next} |
| 60 | + found && $0 ~ "^##[[:space:]]*\\[" {exit} |
| 61 | + found {print} |
| 62 | + ' /tmp/CHANGELOG_ALL) |
| 63 | + if [ -n "${EXTRACTED}" ]; then |
| 64 | + break |
| 65 | + fi |
| 66 | + done |
| 67 | + if [ -n "${EXTRACTED}" ]; then |
| 68 | + CHANGELOG_CONTENT="${EXTRACTED}" |
| 69 | + fi |
| 70 | +fi |
| 71 | + |
| 72 | +# Filter to sections Added / Changed / Fixed / Security, keep their content blocks until next heading of same depth (### ) |
| 73 | +if [ -n "${CHANGELOG_CONTENT}" ]; then |
| 74 | + FILTERED=$(awk ' |
| 75 | + BEGIN{cur=""; keep=0} |
| 76 | + /^###[[:space:]]+Added/ {cur="Added"; keep=1; print; next} |
| 77 | + /^###[[:space:]]+Changed/ {cur="Changed"; keep=1; print; next} |
| 78 | + /^###[[:space:]]+Fixed/ {cur="Fixed"; keep=1; print; next} |
| 79 | + /^###[[:space:]]+Security/ {cur="Security"; keep=1; print; next} |
| 80 | + /^###/ {cur=""; keep=0} |
| 81 | + {if(keep){print}} |
| 82 | + ' <<<"${CHANGELOG_CONTENT}") |
| 83 | + # If filtering yielded something non-empty use it, else keep original |
| 84 | + if [ -n "${FILTERED}" ]; then |
| 85 | + CHANGELOG_CONTENT="${FILTERED}" |
| 86 | + fi |
| 87 | +fi |
| 88 | + |
| 89 | +# Trim leading/trailing blank lines |
| 90 | +trim_blank() { sed -E '/^[[:space:]]*$/{$d;}; 1{/^[[:space:]]*$/d;}' ; } |
| 91 | +CHANGELOG_CONTENT=$(printf '%s\n' "${CHANGELOG_CONTENT}" | sed -E ':a;/^$/{$d;N;ba};' | sed -E '1{/^$/d;}') || true |
| 92 | + |
| 93 | +# Build compare link (try to determine a previous tag) |
| 94 | +COMPARE_LINK="" |
| 95 | + |
| 96 | +# Try several ways to find a previous tag: by creation date, then by semantic/version sort, |
| 97 | +# then by using git describe on the parent commit. This improves chances of producing a |
| 98 | +# meaningful compare URL on repositories with different tag styles. |
| 99 | +PREV_TAG="" |
| 100 | +PREV_TAG=$(git tag --sort=-creatordate | grep -Fvx "${TAG}" | head -n1 || true) |
| 101 | +if [ -z "${PREV_TAG}" ]; then |
| 102 | + PREV_TAG=$(git tag --sort=-v:refname | grep -Fvx "${TAG}" | head -n1 || true) |
| 103 | +fi |
| 104 | +if [ -z "${PREV_TAG}" ]; then |
| 105 | + PREV_TAG=$(git describe --tags --abbrev=0 "${TAG}^" 2>/dev/null || true) |
| 106 | +fi |
| 107 | +if [ -n "${PREV_TAG}" ]; then |
| 108 | + # Only build a compare URL if the requested TAG actually resolves to something the |
| 109 | + # git server can compare to: either a tag ref or a commit-ish. |
| 110 | + if git rev-parse --verify --quiet "refs/tags/${TAG}" >/dev/null 2>&1 || git rev-parse --verify --quiet "${TAG}" >/dev/null 2>&1; then |
| 111 | + COMPARE_URL="${GITHUB_SERVER_URL}/${REPO_OWNER}/${REPO_NAME}/compare/${PREV_TAG}...${TAG}" |
| 112 | + COMPARE_LINK="Full changelog: ${COMPARE_URL}" |
| 113 | + fi |
| 114 | +fi |
| 115 | + |
| 116 | +# Assemble final notes without embedding literal \n sequences |
| 117 | +segments=() |
| 118 | +if [ -n "${TAG_MESSAGE}" ]; then |
| 119 | + segments+=("${TAG_MESSAGE}") |
| 120 | +fi |
| 121 | +if [ -n "${CHANGELOG_CONTENT}" ]; then |
| 122 | + segments+=("${CHANGELOG_CONTENT}") |
| 123 | +fi |
| 124 | +if [ -n "${COMPARE_LINK}" ]; then |
| 125 | + segments+=("${COMPARE_LINK}") |
| 126 | +fi |
| 127 | + |
| 128 | +# Join segments with a blank line |
| 129 | +if [ ${#segments[@]} -gt 0 ]; then |
| 130 | + # Print each segment separated by a blank line |
| 131 | + { |
| 132 | + for i in "${!segments[@]}"; do |
| 133 | + printf '%s' "${segments[$i]}" |
| 134 | + if [ "$i" -lt $((${#segments[@]} - 1)) ]; then |
| 135 | + printf '\n\n' |
| 136 | + else |
| 137 | + printf '\n' |
| 138 | + fi |
| 139 | + done |
| 140 | + } | sed -E ':a;/^$/{$d;N;ba};' # trim trailing blank lines |
| 141 | +fi |
0 commit comments