Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions .github/workflows/eol-release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---
name: EOL release branch

"on":
# release tags (x.y.0). Tags in this repo look like 2.1.0 (no "v" prefix).
push:
tags:
- '[0-9]*.[0-9]*.0'
# Manual replay, and the one-off backfill for 2.1.0 -> release-1.9.
workflow_dispatch:
inputs:
tag:
description: "Release tag that just shipped (e.g. 2.1.0)"
required: true
type: string
Comment thread
rm3l marked this conversation as resolved.
Resolved

permissions:
contents: read

concurrency:
group: eol-release-${{ github.event.inputs.tag || github.ref_name }}
cancel-in-progress: false

jobs:
eol-release:
name: EOL after ${{ github.event.inputs.tag || github.ref_name }}
runs-on: ubuntu-latest
env:
TAG: ${{ github.event.inputs.tag || github.ref_name }}
steps:
- name: Checkout main (tags needed to compute the EOL branch)
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
with:
ref: main
fetch-depth: 0
Comment thread
rm3l marked this conversation as resolved.
Resolved
persist-credentials: false

- name: Validate tag format
id: validate-tag
run: |
if [[ ! "${TAG}" =~ ^[0-9]+\.[0-9]+\.0$ ]]; then
echo "::notice::${TAG} is not a release tag;" \
"skipping EOL processing"
echo "valid=false" >> "$GITHUB_OUTPUT"
exit 0
fi
echo "valid=true" >> "$GITHUB_OUTPUT"

- name: Verify tag exists in the checkout
if: steps.validate-tag.outputs.valid == 'true'
run: |
if ! git show-ref --verify --quiet "refs/tags/${TAG}"; then
echo "::error::${TAG} does not exist in the fetched repository tags"
exit 1
fi

- name: Compute EOL branch and update config files
if: steps.validate-tag.outputs.valid == 'true'
id: eol
run: |
./hack/eol-release.sh --tag "${TAG}" --write \
| tee -a "$GITHUB_STEP_SUMMARY"

- name: Require RHDH_BOT_TOKEN
if: steps.eol.outputs.changed == 'true'
env:
RHDH_BOT_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
run: |
if [[ -z "${RHDH_BOT_TOKEN}" ]]; then
echo "::error::RHDH_BOT_TOKEN must be configured as a repo secret" \
"(rhdh-bot PAT). There is no GITHUB_TOKEN fallback."
exit 1
fi

- name: Open pull request
if: steps.eol.outputs.changed == 'true'
env:
GH_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
REPOSITORY: ${{ github.repository }}
EOL_BRANCH: ${{ steps.eol.outputs.eol_branch }}
EOL_VERSION: ${{ steps.eol.outputs.eol_version }}
run: |
set -euo pipefail
if [[ -z "${EOL_BRANCH}" || -z "${EOL_VERSION}" ]]; then
echo "::error::EOL_BRANCH or EOL_VERSION is empty"
exit 1
fi
BRANCH="chore/eol-${EOL_BRANCH}"
Comment thread
rm3l marked this conversation as resolved.
Resolved

git config user.name "rhdh-bot"
git config user.email "rhdh-bot@redhat.com"
git remote set-url origin \
"https://x-access-token:${GH_TOKEN}@github.com/${REPOSITORY}.git"

git pull --rebase --autostash origin main
git checkout -B "${BRANCH}"
git add .github/workflows/nightly.yaml \
.github/workflows/nightly-upgrade-test.yaml \
.github/renovate.json
Comment thread
rm3l marked this conversation as resolved.
Resolved
git commit -m "chore(ci): end of life ${EOL_BRANCH} after ${TAG}"
git push --force origin "${BRANCH}"

BODY=$(cat <<EOF
Automated end-of-life for \`${EOL_BRANCH}\`, triggered by the
\`${TAG}\` release tag.

- [x] Removed from the nightly matrix
- [x] Removed from the standard upgrade paths
- [x] Left \`nightly-postgresql-upgrade-test.yaml\` untouched
- [x] Renovate rule added (\`enabled: false\`)

> [!NOTE]
> Generated by \`.github/workflows/eol-release.yaml\`.
> The branch itself is not deleted by this automation.
EOF
)

EXISTING=$(gh pr list --head "${BRANCH}" --base main --state open \
--json number --jq '.[0].number // empty')
if [[ -n "${EXISTING}" ]]; then
echo "Updating existing PR #${EXISTING}."
gh pr comment "${EXISTING}" --body "Re-ran for \`${TAG}\`."
else
gh pr create \
--title "chore(ci): end of life ${EOL_BRANCH} after ${TAG}" \
--body "${BODY}" \
--base main
fi
248 changes: 248 additions & 0 deletions hack/eol-release.sh
Comment thread
rm3l marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
#!/usr/bin/env bash
#
# Mark a release branch as end-of-life in the CI and Renovate configuration.
#
# Given the release tag that just shipped (e.g. 2.1.0), compute the release branch
# that is now two release tags behind (release-1.9) and remove it from:
# - .github/workflows/nightly.yaml (nightly matrix)
# - .github/workflows/nightly-upgrade-test.yaml (upgrade paths)
# - .github/renovate.json (disable updates)
#
# Dry-run by default; pass --write to apply the edits.

set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
ROOT="$(cd "${SCRIPT_DIR}/.." && pwd)"
WORK="$(mktemp -d "${TMPDIR:-/tmp}/eol-release.XXXXXX")"
Comment thread
rm3l marked this conversation as resolved.
Resolved

cleanup() {
local exit_code=$?
rm -rf -- "${WORK}" || true
return "${exit_code}"
}

trap cleanup EXIT

TAG=""
TAGS_FILE=""
WRITE=0
CHANGED=0

log() { printf '%s\n' "$*"; }
warn() { printf 'warning: %s\n' "$*" >&2; }
die() { printf 'error: %s\n' "$*" >&2; exit 2; }

usage() {
cat <<'EOF'
Usage:
./hack/eol-release.sh --tag <release tag> [--write] [--root <dir>] [--tags-file <file>]

Options:
--tag <x.y.z> Release tag that just shipped, e.g. 2.1.0 (required)
--write Apply the edits (default: dry-run, prints a diff)
--root <dir> Repository root (default: parent of this script)
--tags-file <f> Read release tags from a file instead of `git tag` (tests)
-h, --help Show this help
EOF
}

parse_args() {
local argument
while [[ $# -gt 0 ]]; do
argument="$1"
case "${argument}" in
--tag) [[ $# -ge 2 ]] || die "--tag needs a value"; TAG="$2"; shift 2 ;;
--root) [[ $# -ge 2 ]] || die "--root needs a value"; ROOT="$2"; shift 2 ;;
--tags-file) [[ $# -ge 2 ]] || die "--tags-file needs a value"; TAGS_FILE="$2"; shift 2 ;;
--write) WRITE=1; shift ;;
--dry-run) WRITE=0; shift ;;
-h|--help) usage; exit 0 ;;
*) die "unknown argument: ${argument}" ;;
esac
done
[[ -n "${TAG}" ]] || { usage >&2; die "--tag is required"; }
[[ "${TAG}" =~ ^[0-9]+\.[0-9]+\.0$ ]] || die "not a release tag (expected x.y.0): ${TAG}"
[[ -d "${ROOT}/.github" ]] || die "not a repository root: ${ROOT}"
}

# Sorted release tags (x.y.0), oldest first.
release_tags() {
local list
if [[ -n "${TAGS_FILE}" ]]; then
list="$(cat "${TAGS_FILE}")"
else
list="$(git -C "${ROOT}" tag --list)"
fi
printf '%s\n' "${list}" | grep -E '^[0-9]+\.[0-9]+\.0$' | sort -V || true
}

# Print the release branch two releases behind the supplied release tag;
# return 1 when there is not enough history.
eol_branch_for_tag() {
local release_tag="$1" list idx eol_tag
list="$(release_tags)"
if ! printf '%s\n' "${list}" | grep -qxF -- "${release_tag}"; then
die "tag ${release_tag} was not found among the fetched release tags"
fi
idx="$(printf '%s\n' "${list}" | grep -nxF -- "${release_tag}" | cut -d: -f1)"
(( idx >= 3 )) || return 1
eol_tag="$(printf '%s\n' "${list}" | sed -n "$((idx - 2))p")"
Comment thread
rm3l marked this conversation as resolved.
Resolved
printf 'release-%s\n' "${eol_tag%.*}"
}

# Swap $1 for $2, respecting dry-run and recording whether anything changed.
commit_file() {
local file="$1" tmp="$2" rel
rel="${file#"${ROOT}"/}"
if cmp -s "${file}" "${tmp}"; then
log "unchanged ${rel}"
return 0
fi
CHANGED=1
log "update ${rel}"
if (( WRITE )); then
mv "${tmp}" "${file}"
else
diff -u "${file}" "${tmp}" || true
fi
}

# Drop "- <branch>" from a YAML matrix list.
edit_nightly_matrix() {
local file="$1" branch="$2" tmp
tmp="${WORK}/nightly.yaml.new"
if ! grep -qE "^[[:space:]]*-[[:space:]]*${branch}[[:space:]]*$" "${file}"; then
log "no nightly matrix entry for ${branch} (already removed)"
return 0
fi
awk -v b="${branch}" '
$0 ~ "^[[:space:]]*-[[:space:]]*" b "[[:space:]]*$" { next }
{ print }
' "${file}" > "${tmp}"
commit_file "${file}" "${tmp}"
}

Comment thread
rm3l marked this conversation as resolved.
Resolved
# Drop "- from_branch: X" / "to_branch: Y" pairs mentioning $branch.
# Leaves the file untouched (with a warning) if this would empty the matrix.
edit_upgrade_matrix() {
local file="$1" branch="$2" tmp remaining
tmp="${WORK}/$(basename "${file}").new"
if ! grep -qE "^[[:space:]]*(-[[:space:]]*)?(from|to)_branch:[[:space:]]*${branch}[[:space:]]*$" "${file}"; then
log "no upgrade path for ${branch} in $(basename "${file}") (already removed)"
return 0
fi
awk -v b="${branch}" '
{ line[NR] = $0 }
END {
removed = 0
for (i = 1; i <= NR; i++) {
if (line[i] ~ /^[[:space:]]*-[[:space:]]*from_branch:/ && line[i+1] ~ /^[[:space:]]*to_branch:/) {
f = line[i]; sub(/.*from_branch:[[:space:]]*/, "", f); sub(/[[:space:]]+$/, "", f)
t = line[i+1]; sub(/.*to_branch:[[:space:]]*/, "", t); sub(/[[:space:]]+$/, "", t)
if (f == b || t == b) { i++; removed++; continue }
}
print line[i]
}
if (removed == 0) exit 3
}
' "${file}" > "${tmp}" || die "failed to rewrite ${file}"
remaining="$(grep -cE '^[[:space:]]*-[[:space:]]*from_branch:' "${tmp}" || true)"
if [[ "${remaining}" -eq 0 ]]; then
warn "$(basename "${file}") would have an empty matrix; left unchanged, fix it by hand"
rm -f "${tmp}"
return 0
fi
commit_file "${file}" "${tmp}"
}
Comment thread
rm3l marked this conversation as resolved.
Resolved

# Append an "enabled: false" rule for the branch to packageRules.
# Appended last on purpose: in Renovate, later matching rules win.
edit_renovate() {
local file="$1" branch="$2" tmp
tmp="${WORK}/renovate.json.new"
if grep -qF "\"matchBaseBranches\": [\"${branch}\"]" "${file}"; then
log "renovate already disables ${branch}"
return 0
fi
awk -v b="${branch}" '
{ line[NR] = $0 }
END {
depth = 0; endline = 0
for (i = 1; i <= NR && !endline; i++) {
if (depth == 0 && line[i] !~ /"packageRules"[[:space:]]*:[[:space:]]*\[/) continue
n = length(line[i]); instr = 0
for (j = 1; j <= n; j++) {
c = substr(line[i], j, 1)
if (c == "\"") instr = !instr
else if (!instr) {
if (c == "[") depth++
else if (c == "]") { depth--; if (depth == 0) { endline = i; break } }
}
}
}
if (!endline) exit 5
if (line[endline-1] !~ /^[[:space:]]*\}[[:space:]]*$/) exit 4
for (i = 1; i < endline; i++) {
if (i == endline - 1) print line[i] ","; else print line[i]
}
print " {"
print " \"description\": \"" b " is end-of-life: no dependency updates\","
print " \"matchBaseBranches\": [\"" b "\"],"
print " \"enabled\": false"
print " }"
for (i = endline; i <= NR; i++) print line[i]
}
' "${file}" > "${tmp}" || die "could not insert packageRules entry in ${file}"
if command -v jq >/dev/null 2>&1; then
jq -e . "${tmp}" >/dev/null || die "renovate.json would be invalid JSON"
fi
Comment thread
rm3l marked this conversation as resolved.
Resolved
commit_file "${file}" "${tmp}"
}

write_outputs() {
local eol_branch="$1" changed="$2"
printf 'EOL_BRANCH=%s\nCHANGED=%s\n' "${eol_branch}" "${changed}"
if [[ -n "${GITHUB_OUTPUT:-}" ]]; then
{
printf 'eol_branch=%s\n' "${eol_branch}"
printf 'eol_version=%s\n' "${eol_branch#release-}"
printf 'changed=%s\n' "${changed}"
} >> "${GITHUB_OUTPUT}"
fi
if [[ -n "${GITHUB_ENV:-}" ]]; then
printf 'TAG=%s\nEOL_BRANCH=%s\n' "${TAG}" "${eol_branch}" >> "${GITHUB_ENV}"
fi
}

main() {
parse_args "$@"

local eol_branch changed=false rc
if eol_branch="$(eol_branch_for_tag "${TAG}")"; then
:
else
rc=$?
if (( rc == 1 )); then
log "not enough release history to determine EOL branch for ${TAG}; nothing to do"
write_outputs "" "false"
exit 0
fi
exit "${rc}"
fi
log "tag=${TAG} eol=${eol_branch}"

edit_nightly_matrix "${ROOT}/.github/workflows/nightly.yaml" "${eol_branch}"
edit_upgrade_matrix "${ROOT}/.github/workflows/nightly-upgrade-test.yaml" "${eol_branch}"
edit_renovate "${ROOT}/.github/renovate.json" "${eol_branch}"

(( CHANGED )) && changed=true
if [[ "${changed}" == "false" ]]; then
log "nothing to do"
elif (( ! WRITE )); then
log "dry-run: no files written (use --write to apply)"
fi
write_outputs "${eol_branch}" "${changed}"
}

main "$@"
Loading