Page MenuHomePhabricator

Fix release notes that got automated out of existence
ClosedPublic

Authored by jasonbcox on Oct 7 2020, 02:20.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABCca05a7160d20: Fix release notes that got automated out of existence
Summary

This patch loosens the regex that's used to fetch the version number
from the release notes file. The automation was broken due to a new heading that
was added in D7544, but the breakage only occurred after the 0.22.3 release.
The breakage resulted in archiving the release notes to a badly formed file,
effectively erasing release notes as changes were landed via the land bot.

This patch also restores the 0.22.4 release notes that got removed due to the above.

Test Plan
./contrib/source-control-tools/autogen-recipes/50-archive-release-notes.sh

Pre-patch, obvserve that the release notes version is ''.
Post-patch, the release notes version is matched correctly (and the archiving appropriately skipped).

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Fabien requested changes to this revision.Oct 7 2020, 08:04
Fabien added a subscriber: Fabien.
Fabien added inline comments.
contrib/source-control-tools/autogen-recipes/50-archive-release-notes.sh
12 ↗(On Diff #24321)

This will break again each time the template is changed.
A better solution would be to use the template itself, but it's a bit more complicated. dwdiff can help:

dwdiff -2 <(head -n1 doc/release-notes.md) <(head -n1 doc/release-notes/release-notes.md.in) | sed 's/.*\[-\([0-9.]\+\)-\].*/\1/'
This revision now requires changes to proceed.Oct 7 2020, 08:04

Came up with a better solution that is more robust, fails when there is no version number found, and
does not introduce a new dependency.

Fabien added inline comments.
contrib/source-control-tools/autogen-recipes/50-archive-release-notes.sh
14 ↗(On Diff #24343)

Use + instead of *, or it will match ..

This revision is now accepted and ready to land.Oct 7 2020, 16:09