diff options
author | eldritch horrors <pennae@lix.systems> | 2024-04-08 20:20:50 +0200 |
---|---|---|
committer | eldritch horrors <pennae@lix.systems> | 2024-04-09 02:09:36 +0000 |
commit | d9bc197ff4cf3fa1d80e213ddc56efd7d09a5d63 (patch) | |
tree | 374ce25c15436a7b48567f5b17ac673e4d74a29c /maintainers | |
parent | 07ef9f9f5d88f4d278291d78faf2e0b0a067cb8e (diff) |
docs: don't compute rl-next.md during build
not sure why this was done the way it was considering that includes are
a feature the doc toolchain had previously. let's just always have some
kind of entry for the upcoming release in the dev manual builds even if
that means having a completely empty release notes chapter.
the release notes generation script isn't entirely functional right now
due to pre-commit hooks, but it's good enough for time being. we need a
better release process for notes anyway.
Change-Id: Ifda6912cf5233db013f72a30247a62d6f22b1565
Change-Id: I9eb347ec4aabc5be2b816ff0fd3e4be45f93b934
Diffstat (limited to 'maintainers')
-rwxr-xr-x | maintainers/release-notes | 10 | ||||
-rw-r--r-- | maintainers/release-process.md | 1 |
2 files changed, 6 insertions, 5 deletions
diff --git a/maintainers/release-notes b/maintainers/release-notes index c7a4e5074..477df31f1 100755 --- a/maintainers/release-notes +++ b/maintainers/release-notes @@ -8,7 +8,7 @@ # This does double duty for # - including rl-next # - marking where to insert new links (right after) -SUMMARY_MARKER_LINE='{{#include ./SUMMARY-rl-next.md}}' +SUMMARY_MARKER_LINE='release-notes/rl-next.md' # --- LIB --- @@ -79,9 +79,9 @@ if ! git diff --quiet --cached; then die "repo has staged changes, please commit or stash them" fi -if ! grep "$SUMMARY_MARKER_LINE" doc/manual/src/SUMMARY.md.in >/dev/null; then +if ! grep -F "$SUMMARY_MARKER_LINE" doc/manual/src/SUMMARY.md >/dev/null; then # would have been nice to catch this early, but won't be worth the extra infra - die "SUMMARY.md.in is missing the marker line '$SUMMARY_MARKER_LINE', which would be used for inserting a new release notes page. Please fix the script." + die "SUMMARY.md is missing the marker line '$SUMMARY_MARKER_LINE', which would be used for inserting a new release notes page. Please fix the script." fi if [[ ! -n "${VERSION:-}" ]]; then @@ -163,7 +163,7 @@ if ! $IS_PATCH; then # find the marker line, insert new link after it escaped_marker="$(echo "$SUMMARY_MARKER_LINE" | sed -e 's/\//\\\//g' -e 's/ /\\ /g')" escaped_line="$(echo "$NEW_SUMMARY_LINE" | sed -e 's/\//\\\//g' -e 's/ /\\ /g')" - logcmd sed -i -e "/$escaped_marker/a $escaped_line" doc/manual/src/SUMMARY.md.in + logcmd sed -i -e "/$escaped_marker/a $escaped_line" doc/manual/src/SUMMARY.md fi for f in doc/manual/rl-next/*.md; do @@ -172,7 +172,7 @@ for f in doc/manual/rl-next/*.md; do fi done -logcmd git add $file doc/manual/src/SUMMARY.md.in +logcmd git add $file doc/manual/src/SUMMARY.md logcmd git status logcmd git commit -m "release notes: $version_full" diff --git a/maintainers/release-process.md b/maintainers/release-process.md index 5d68b2861..f2b60d8e7 100644 --- a/maintainers/release-process.md +++ b/maintainers/release-process.md @@ -60,6 +60,7 @@ release: ```console $ sed -e 's/officialRelease = false;/officialRelease = true;/' -i flake.nix + $ sed -e '/rl-next.md/ d' -i doc/manual/src/SUMMARY.md ``` This removes the link to `rl-next.md` from the manual and sets |