Skip to content

fix(release): pin the compare base of a versioned CHANGELOG section #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
waterbro-8 wants to merge 1 commit into from
+13 −5
Closed

fix(release): pin the compare base of a versioned CHANGELOG section #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions scripts/validate_release_version.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,19 @@ while IFS= read -r version_link; do
done < <(grep -F -- "[${version}]: " "${changelog}" || true)
[[ "${#version_links[@]}" == 1 ]] ||
die "CHANGELOG.md: expected exactly one [${version}] comparison link"
if [[ "${version_links[0]}" != \
"[${version}]: https://github.com/bytefolk/mem/releases/tag/v${version}" &&
"${version_links[0]}" != \
"[${version}]: https://github.com/bytefolk/mem/compare/"*"...v${version}" ]]; then
die "CHANGELOG.md: [${version}] link must terminate at v${version}"
# The compare base is the field that decides which commits a release holds,
# so a wildcard there would let the gate pass a section that quietly widens
# or narrows the release. The heading above already pins ${version} as the
# first versioned section, making the second one the release it follows.
previous_version="$(sed -nE 's/^## \[([0-9][^]]*)\].*/\1/p' "${changelog}" | awk 'NR == 2')"
release_tag_link="[${version}]: https://github.com/bytefolk/mem/releases/tag/v${version}"
compare_link="[${version}]: https://github.com/bytefolk/mem/compare/v${previous_version}...v${version}"
if [[ "${version_links[0]}" == "${release_tag_link}" ]]; then
:
elif [[ -z "${previous_version}" ]]; then
die "CHANGELOG.md: cannot derive the previous release heading for [${version}]"
elif [[ "${version_links[0]}" != "${compare_link}" ]]; then
die "CHANGELOG.md: [${version}] link must be ${compare_link}"
fi

printf 'PASS: all release version surfaces match %s\n' "${version}"
Loading