Skip to content

Commit a0eb503

Browse files
rustyrussellShahanaFarooqui
authored andcommitted
doc: make sure v prefix is always on the version.
1. Put v prefix before NEW_VERSION 2. Change the checkin line to a one-liner. 3. Have build-release.sh check for the v prefix (with --force-version= you could omit it). Signed-off-by: Rusty Russell <[email protected]>
1 parent 8ba6522 commit a0eb503

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

doc/contribute-to-core-lightning/release-checklist.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Here's a checklist for the release process.
2424
2. Use `devtools/changelog.py` to collect the changelog entries from pull request commit messages and merge them into the manually maintained `CHANGELOG.md`. This does API queries to GitHub, which are severely
2525
ratelimited unless you use an API token: set the `GH_TOKEN` environment variable to a Personal Access Token from <https://github.com/settings/tokens>
2626
3. Create a new CHANGELOG.md heading to `v<VERSION>rc1`, and create a link at the bottom. Note that you should exactly copy the date and name format from a previous release, as the `build-release.sh` script relies on this.
27-
4. Update the package versions: `make update-versions NEW_VERSION=<VERSION>rc1`
27+
4. Update the package versions: `make update-versions NEW_VERSION=v<VERSION>rc1`
2828
5. Create a PR with the above.
2929

3030
## Releasing -rc1
@@ -46,7 +46,7 @@ Here's a checklist for the release process.
4646
## Releasing -rc2, ..., -rcN
4747

4848
1. Update CHANGELOG.md by changing rc(N-1) to rcN. Update the changelog list with information from newly merged PRs also.
49-
2. Update the package versions: `make update-versions NEW_VERSION=<VERSION>rcN`
49+
2. Update the package versions: `make update-versions NEW_VERSION=v<VERSION>rcN`
5050
3. Add a PR with the rcN.
5151
4. Tag it `git pull && git tag -s v<VERSION>rcN && git push --tags`
5252
5. Draft a new `v<VERSION>rcN` pre-release on Github, upload reproducible builds, `SHA256SUMS-v<VERSION>` and `SHA256SUMS-v<VERSION>.asc`.
@@ -57,12 +57,11 @@ Here's a checklist for the release process.
5757
## Tagging the Release
5858

5959
1. Update the CHANGELOG.md; remove -rcN in both places, update the date and add title and namer.
60-
2. Update the contrib/pyln package versions: `make update-versions NEW_VERSION=<VERSION>`
60+
2. Update the contrib/pyln package versions: `make update-versions NEW_VERSION=v<VERSION>`
6161
3. Add a PR with that release.
6262
4. Merge the PR, then:
63-
- `export VERSION=23.05`
6463
- `git pull`
65-
- `git tag -a -s v${VERSION} -m v${VERSION}`
64+
- `VERSION=23.05; git tag -a -s v$VERSION -m v$VERSION`
6665
- `git push --tags`
6766
5. Run `tools/build-release.sh` (with `--sudo` if you need root to run Docker) to:
6867
- Create reproducible zipfile

tools/build-release.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,15 @@ if [ "$VERSION" = "" ]; then
8787
exit 1
8888
fi
8989

90+
# Don't forget the v prefix!
91+
case "$VERSION" in
92+
v*) ;;
93+
*)
94+
echo "Version must begin with v! Not $VERSION" >&2
95+
exit 1
96+
;;
97+
esac
98+
9099
# `status --porcelain -u no` suppressed modified! Bug reported...
91100
if [ "$(git diff --name-only)" != "" ] && ! $FORCE_UNCLEAN; then
92101
echo "Not a clean git directory" >&2

0 commit comments

Comments
 (0)