Skip to content

Commit

Permalink
doc: Fix documentation version
Browse files Browse the repository at this point in the history
Changelog-Fixed: The documentation version was calculated as `pre-v24.08` for point releases like v24.08.1` also because `CLN_NEXT_VERSION` has not been included in the point release branches. Updating the script to build documentation on new tags and change the version to `pre-cln-next-version` for non-tagged commits.
  • Loading branch information
ShahanaFarooqui authored and rustyrussell committed Oct 16, 2024
1 parent fe344ee commit 2171583
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,15 @@ LOWDOWN := lowdown
endif

# For versions in documentation, we don't change with every git version, to
# save build time. We simply to pre-XXX and XXX.
# save build time. We build them on new tags or keep them on pre-next-release version.
doc/.doc_version: version_gen.h
@if [ "$(VERSION)" = "$(CLN_NEXT_VERSION)" ]; then DOC_VERSION="$(VERSION)"; else DOC_VERSION="pre-$(CLN_NEXT_VERSION)"; fi; echo $$DOC_VERSION > $@.new
@case "$(VERSION)" in \
*-*-g*) \
DOC_VERSION="pre-$(CLN_NEXT_VERSION)";; \
*) \
DOC_VERSION="$(VERSION)";; \
esac; \
echo $$DOC_VERSION > $@.new
@if cmp $@.new $@ >/dev/null 2>&1; then rm -f $@.new; else mv $@.new $@; $(ECHO) Documentation version updated to `cat doc/.doc_version`; fi

$(MANPAGES): doc/%: doc/%.md tools/md2man.sh doc/.doc_version
Expand Down

0 comments on commit 2171583

Please sign in to comment.