Skip to content

Commit

Permalink
meta: Update release checklist
Browse files Browse the repository at this point in the history
Add a version bump for clnrest and the main poetry.lock to the makefile
and update the release checklist to include the new target.

Signed-off-by: Peter Neuroth <[email protected]>
  • Loading branch information
nepet committed Nov 16, 2023
1 parent cc2665d commit 8f8202d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
11 changes: 10 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,9 @@ clean: obsclean


PYLNS=client proto testing
# See doc/MAKING-RELEASES.md
# See doc/contribute-to-core-lightning/contributor-workflow.md
update-py-versions: update-pyln-versions update-clnrest-version update-poetry-lock

update-pyln-versions: $(PYLNS:%=update-pyln-version-%)

update-pyln-version-%:
Expand All @@ -730,6 +732,13 @@ pyln-release: $(PYLNS:%=pyln-release-%)
pyln-release-%:
cd contrib/pyln-$* && $(MAKE) prod-release

update-clnrest-version:
@if [ -z "$(NEW_VERSION)" ]; then echo "Set NEW_VERSION!" >&2; exit 1; fi
cd plugins/clnrest && $(MAKE) upgrade-version

update-poetry-lock:
poetry update clnrest pyln-client pyln-proto pyln-testing

update-mocks: $(ALL_TEST_PROGRAMS:%=update-mocks/%.c)

$(ALL_TEST_PROGRAMS:%=update-mocks/%.c): $(ALL_GEN_HEADERS) $(EXTERNAL_LIBS) libccan.a ccan/ccan/cdump/tools/cdump-enumstr config.vars
Expand Down
4 changes: 2 additions & 2 deletions doc/contribute-to-core-lightning/contributor-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Here's a checklist for the release process.
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
ratelimited unless you use an API token: set the `GH_TOKEN` environment variable to a Personal Access Token from <https://github.com/settings/tokens>
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.
4. Update the contrib/pyln package versions: `make update-pyln-versions NEW_VERSION=<VERSION>`
4. Update the contrib/pyln package versions: `make update-py-versions NEW_VERSION=<VERSION>`
5. Create a PR with the above.

### Releasing -rc1
Expand All @@ -130,7 +130,7 @@ Here's a checklist for the release process.
### Releasing -rc2, ..., -rcN

1. Change rc(N-1) to rcN in CHANGELOG.md.
2. Update the contrib/pyln package versions: `make update-pyln-versions NEW_VERSION=<VERSION>`
2. Update the contrib/pyln package versions: `make update-py-versions NEW_VERSION=<VERSION>`
3. Add a PR with the rcN.
4. Tag it `git pull && git tag -s v<VERSION>rcN && git push --tags`
5. Announce tagged rc release on core-lightning's release-chat channel on Discord & [BuildOnL2](https://community.corelightning.org/c/general-questions/).
Expand Down
3 changes: 3 additions & 0 deletions plugins/clnrest/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
upgrade-version:
if [ -z "$(NEW_VERSION)" ]; then echo "Set NEW_VERSION!" >&2; exit 1; fi
poetry version $(NEW_VERSION)

0 comments on commit 8f8202d

Please sign in to comment.