From b7982372d234b1fd15bab01d09093471c1870bb4 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 19 Nov 2023 15:05:21 +0100
Subject: [PATCH 01/11] Compile hand-written release notes with changelog-d

---
 .gitignore                             |  1 +
 doc/manual/local.mk                    |  5 +++-
 doc/manual/rl-next/config              |  2 ++
 doc/manual/src/contributing/hacking.md | 38 ++++++++++++++++++++++++++
 flake.nix                              | 11 +++++++-
 5 files changed, 55 insertions(+), 2 deletions(-)
 create mode 100644 doc/manual/rl-next/config

diff --git a/.gitignore b/.gitignore
index 04d96ca2c..38e7e2b5a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -27,6 +27,7 @@ perl/Makefile.config
 /doc/manual/src/contributing/experimental-feature-descriptions.md
 /doc/manual/src/language/builtins.md
 /doc/manual/src/language/builtin-constants.md
+/doc/manual/src/release-notes/rl-next.md
 
 # /scripts/
 /scripts/nix-profile.sh
diff --git a/doc/manual/local.mk b/doc/manual/local.mk
index db3daf252..74a4103b3 100644
--- a/doc/manual/local.mk
+++ b/doc/manual/local.mk
@@ -144,6 +144,9 @@ $(d)/language.json: $(bindir)/nix
 	$(trace-gen) $(dummy-env) $(bindir)/nix __dump-language > $@.tmp
 	@mv $@.tmp $@
 
+$(d)/src/release-notes/rl-next.md: $(d)/rl-next/*
+	$(trace-gen) changelog-d doc/manual/rl-next > $@
+
 # Generate the HTML manual.
 .PHONY: manual-html
 manual-html: $(docdir)/manual/index.html
@@ -177,7 +180,7 @@ doc/manual/generated/man1/nix3-manpages: $(d)/src/command-ref/new-cli
 # `@docroot@` is to be preserved for documenting the mechanism
 # FIXME: maybe contributing guides should live right next to the code
 # instead of in the manual
-$(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/anchors.jq $(d)/custom.css $(d)/src/SUMMARY.md $(d)/src/command-ref/new-cli $(d)/src/contributing/experimental-feature-descriptions.md $(d)/src/command-ref/conf-file.md $(d)/src/language/builtins.md $(d)/src/language/builtin-constants.md
+$(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/anchors.jq $(d)/custom.css $(d)/src/SUMMARY.md $(d)/src/command-ref/new-cli $(d)/src/contributing/experimental-feature-descriptions.md $(d)/src/command-ref/conf-file.md $(d)/src/language/builtins.md $(d)/src/language/builtin-constants.md $(d)/src/release-notes/rl-next.md
 	$(trace-gen) \
 		tmp="$$(mktemp -d)"; \
 		cp -r doc/manual "$$tmp"; \
diff --git a/doc/manual/rl-next/config b/doc/manual/rl-next/config
new file mode 100644
index 000000000..b3c2e868f
--- /dev/null
+++ b/doc/manual/rl-next/config
@@ -0,0 +1,2 @@
+organization: NixOS
+repository: nix
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md
index fe08ceb94..855900d7a 100644
--- a/doc/manual/src/contributing/hacking.md
+++ b/doc/manual/src/contributing/hacking.md
@@ -220,3 +220,41 @@ Configure your editor to use the `clangd` from the shell, either by running it i
 > For some editors (e.g. Visual Studio Code), you may need to install a [special extension](https://open-vsx.org/extension/llvm-vs-code-extensions/vscode-clangd) for the editor to interact with `clangd`.
 > Some other editors (e.g. Emacs, Vim) need a plugin to support LSP servers in general (e.g. [lsp-mode](https://github.com/emacs-lsp/lsp-mode) for Emacs and [vim-lsp](https://github.com/prabirshrestha/vim-lsp) for vim).
 > Editor-specific setup is typically opinionated, so we will not cover it here in more detail.
+
+## Add a release note
+
+`doc/manual/rl-next` contains release notes entries for all unreleased changes.
+
+User-visible changes should come with a release note.
+
+### Add an entry
+
+Here's what a complete entry looks like. The file name is not incorporated in the document.
+
+```
+synopsis: Basically a title
+issues: #1234
+prs: #1238
+description: {
+
+Here's one or more paragraphs that describe the change.
+
+- It's markdown
+- Add references to the manual using @docroot@
+
+}
+```
+
+Significant changes should add the following header, which moves them to the top.
+
+```
+significance: significant
+```
+
+<!-- Keep an eye on https://codeberg.org/fgaz/changelog-d/issues/1 -->
+See also the [format documentation](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#changelog).
+
+### Build process
+
+Releases have a precomputed `rl-MAJOR.MINOR.md`, and no `rl-next.md`.
+Non-releases build the release notes on the fly.
diff --git a/flake.nix b/flake.nix
index 9030a74f7..ca37948a7 100644
--- a/flake.nix
+++ b/flake.nix
@@ -173,6 +173,10 @@
           "--enable-internal-api-docs"
         ];
 
+        # TODO: after backport of https://github.com/NixOS/nixpkgs/pull/268487, remove `haskellPackages.` -
+        #       vastly improves output closure, and adds shell completions
+        changelog-d = pkgs.buildPackages.haskellPackages.changelog-d;
+
         nativeBuildDeps =
           [
             buildPackages.bison
@@ -190,7 +194,10 @@
             buildPackages.jq # Also for custom mdBook preprocessor.
             buildPackages.openssh # only needed for tests (ssh-keygen)
           ]
-          ++ lib.optionals stdenv.hostPlatform.isLinux [(buildPackages.util-linuxMinimal or buildPackages.utillinuxMinimal)];
+          ++ lib.optionals stdenv.hostPlatform.isLinux [(buildPackages.util-linuxMinimal or buildPackages.utillinuxMinimal)]
+          # Official releases don't have rl-next, so we don't need to compile a changelog
+          ++ lib.optional (!officialRelease) changelog-d
+          ;
 
         buildDeps =
           [ curl
@@ -727,6 +734,8 @@
               ++ lib.optional
                 (stdenv.cc.isClang && stdenv.hostPlatform == stdenv.buildPlatform)
                 pkgs.buildPackages.clang-tools
+              # We want changelog-d in the shell even if it's an official release
+              ++ lib.optional officialRelease changelog-d
               ;
 
             buildInputs = buildDeps ++ propagatedDeps

From b26038c517ed10feae751ad6733244c00b715d34 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 19 Nov 2023 16:08:34 +0100
Subject: [PATCH 02/11] doc: Rename 2X.XX to "Upcoming release", and only
 generate if applicable

---
 .gitignore                   |  1 +
 doc/manual/local.mk          | 13 +++++++++++--
 doc/manual/src/SUMMARY.md.in |  2 +-
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 38e7e2b5a..5c359d7a0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -21,6 +21,7 @@ perl/Makefile.config
 /doc/manual/language.json
 /doc/manual/xp-features.json
 /doc/manual/src/SUMMARY.md
+/doc/manual/src/SUMMARY-rl-next.md
 /doc/manual/src/command-ref/new-cli
 /doc/manual/src/command-ref/conf-file.md
 /doc/manual/src/command-ref/experimental-features-shortlist.md
diff --git a/doc/manual/local.mk b/doc/manual/local.mk
index 74a4103b3..265a4649d 100644
--- a/doc/manual/local.mk
+++ b/doc/manual/local.mk
@@ -92,7 +92,7 @@ $(d)/nix-profiles.5: $(d)/src/command-ref/files/profiles.md
 	$(trace-gen) lowdown -sT man --nroff-nolinks -M section=5 $^.tmp -o $@
 	@rm $^.tmp
 
-$(d)/src/SUMMARY.md: $(d)/src/SUMMARY.md.in $(d)/src/command-ref/new-cli $(d)/src/contributing/experimental-feature-descriptions.md
+$(d)/src/SUMMARY.md: $(d)/src/SUMMARY.md.in $(d)/src/SUMMARY-rl-next.md $(d)/src/command-ref/new-cli $(d)/src/contributing/experimental-feature-descriptions.md
 	@cp $< $@
 	@$(call process-includes,$@,$@)
 
@@ -144,9 +144,18 @@ $(d)/language.json: $(bindir)/nix
 	$(trace-gen) $(dummy-env) $(bindir)/nix __dump-language > $@.tmp
 	@mv $@.tmp $@
 
-$(d)/src/release-notes/rl-next.md: $(d)/rl-next/*
+# Generate "Upcoming release" notes (or clear it and remove from menu)
+$(d)/src/release-notes/rl-next.md: $(d)/rl-next $(d)/rl-next/*
 	$(trace-gen) changelog-d doc/manual/rl-next > $@
 
+$(d)/src/SUMMARY-rl-next.md: $(d)/src/release-notes/rl-next.md
+	$(trace-gen) true
+	@if [ -s $< ]; then \
+		echo '  - [Upcoming release](release-notes/rl-next.md)' > $@; \
+	else \
+	  true > $@; \
+	fi
+
 # Generate the HTML manual.
 .PHONY: manual-html
 manual-html: $(docdir)/manual/index.html
diff --git a/doc/manual/src/SUMMARY.md.in b/doc/manual/src/SUMMARY.md.in
index 8dc464abd..8e7b4eeab 100644
--- a/doc/manual/src/SUMMARY.md.in
+++ b/doc/manual/src/SUMMARY.md.in
@@ -114,7 +114,7 @@
   - [CLI guideline](contributing/cli-guideline.md)
   - [C++ style guide](contributing/cxx.md)
 - [Release Notes](release-notes/release-notes.md)
-  - [Release X.Y (202?-??-??)](release-notes/rl-next.md)
+{{#include ./SUMMARY-rl-next.md}}
   - [Release 2.19 (2023-11-17)](release-notes/rl-2.19.md)
   - [Release 2.18 (2023-09-20)](release-notes/rl-2.18.md)
   - [Release 2.17 (2023-07-24)](release-notes/rl-2.17.md)

From 2a538c571b13877fa426f2cff2749cf17d140216 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 19 Nov 2023 16:49:11 +0100
Subject: [PATCH 03/11] Add scripts/release-notes

---
 maintainers/release-process.md |  45 ++++------
 scripts/release-notes          | 148 +++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+), 27 deletions(-)
 create mode 100755 scripts/release-notes

diff --git a/maintainers/release-process.md b/maintainers/release-process.md
index d85266b81..e542d8be5 100644
--- a/maintainers/release-process.md
+++ b/maintainers/release-process.md
@@ -24,34 +24,23 @@ release:
 * In a checkout of the Nix repo, make sure you're on `master` and run
   `git pull`.
 
-* Move the contents of `doc/manual/src/release-notes/rl-next.md`
-  (except the first line) to
-  `doc/manual/src/release-notes/rl-$VERSION.md` (where `$VERSION` is
-  the contents of `.version` *without* the patch level, e.g. `2.12`
-  rather than `2.12.0`).
-
-* Add a header to `doc/manual/src/release-notes/rl-$VERSION.md` like
-
-  ```
-  # Release 2.12 (2022-12-06)
-  ```
-
-* Proof-read / edit / rearrange the release notes. Breaking changes
-  and highlights should go to the top.
-
-* Add a link to the release notes to `doc/manual/src/SUMMARY.md.in`
-  (*not* `SUMMARY.md`), e.g.
-
-  ```
-  - [Release 2.12 (2022-12-06)](release-notes/rl-2.12.md)
-  ```
-
-* Run
+* Compile the release notes by running
 
   ```console
   $ git checkout -b release-notes
-  $ git add doc/manual/src/release-notes/rl-$VERSION.md
-  $ git commit -a -m 'Release notes'
+  $ VERSION=X.YY ./scripts/release-notes
+  ```
+
+  where `X.YY` is *without* the patch level, e.g. `2.12` rather than ~~`2.12.0`~~.
+
+  A commit is created.
+
+* Proof-read / edit / rearrange the release notes if needed. Breaking changes
+  and highlights should go to the top.
+
+* Push.
+
+  ```console
   $ git push --set-upstream $REMOTE release-notes
   ```
 
@@ -67,15 +56,17 @@ release:
   $ git checkout -b $VERSION-maintenance
   ```
 
-* Mark the release as stable:
+* Mark the release as official:
 
   ```console
-  $ git cherry-pick f673551e71942a52b6d7ae66af8b67140904a76a
+  $ sed -e 's/officialRelease = false;/officialRelease = true;/' -i flake.nix
   ```
 
   This removes the link to `rl-next.md` from the manual and sets
   `officialRelease = true` in `flake.nix`.
 
+* Commit
+
 * Push the release branch:
 
   ```console
diff --git a/scripts/release-notes b/scripts/release-notes
new file mode 100755
index 000000000..e5ee39d11
--- /dev/null
+++ b/scripts/release-notes
@@ -0,0 +1,148 @@
+#!/usr/bin/env nix-shell
+#!nix-shell -i bash ../shell.nix -I nixpkgs=channel:nixos-unstable-small
+#                                   ^^^^^^^
+#                Only used for bash. shell.nix goes to the flake.
+
+# --- CONFIGURATION ---
+
+# This does double duty for
+# - including rl-next
+# - marking where to insert new links (right after)
+SUMMARY_MARKER_LINE='{{#include ./SUMMARY-rl-next.md}}'
+
+# --- LIB ---
+
+log() {
+  echo 1>&2 "release-notes:" "$@"
+}
+logcmd() {
+  local cmd="$1"
+  shift
+  logcmd2 "$cmd" "${*@Q}" "$cmd" "$@"
+}
+logcmd2() {
+  local fakecmd="$1"
+  local fakeargs="$2"
+  shift
+  shift
+  printf 1>&2 "release-notes: \033[34;1m$fakecmd\033[0m "
+  echo "$fakeargs" 1>&2
+  "$@"
+}
+die() {
+  # ANSI red
+  printf 1>&2 "release-notes: \033[31;1merror:\033[0m"
+  echo 1>&2 "" "$@"
+  exit 1
+}
+confirm() {
+  local answer
+  echo 1>&2 "$@" "[y/n]"
+  read -r answer
+  case "$answer" in
+    y|Y|yes|Yes|YES)
+      return 0
+      ;;
+    n|N|no|No|NO)
+      return 1
+      ;;
+    *)
+      echo 1>&2 "please answer y or n"
+      confirm "$@"
+      ;;
+  esac
+}
+report_done() {
+  logcmd2 "git" "show" git -c pager.show=false show
+  printf 1>&2 "release-notes: \033[32;1mdone\033[0m\n"
+}
+
+# --- PARSE ARGS ---
+
+if [[ $# -gt 0 ]]; then
+  die "Release notes takes no arguments, but make sure to set VERSION."
+fi
+
+# --- CHECKS ---
+
+if [[ ! -e flake.nix ]] || [[ ! -e .git ]]; then
+  die "must run in repo root"
+  exit 1
+fi
+
+# repo must be clean
+if ! git diff --quiet; then
+  die "repo is dirty, please commit or stash changes"
+fi
+
+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
+  # 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."
+fi
+
+if [[ ! -n "${VERSION:-}" ]]; then
+  die "please set the VERSION environment variable before invoking this script"
+  exit 1
+fi
+
+case "$VERSION" in
+  # FIXME: accepts "." without any real digits
+  [[:digit:]]*.[[:digit:]]*)
+    ;;
+  *)
+    die "VERSION must be MAJOR.MINOR, where each is a number, e.g. 2.20 (VERSION was set to $VERSION)"
+    ;;
+esac
+
+# --- DEFAULTS ---
+
+if [[ ! -n "${DATE:-}" ]]; then
+  DATE="$(date +%Y-%m-%d)"
+  log "DATE not set, using $DATE"
+fi
+
+case "$DATE" in
+  [[:digit:]]*-[[:digit:]]*-[[:digit:]]*)
+    ;;
+  *)
+    die "DATE must be YYYY-MM-DD, e.g. 2021-12-31 (DATE was set to $DATE)"
+    ;;
+esac
+
+# --- DO THE WORK ---
+
+basename=rl-$VERSION.md
+file=doc/manual/src/release-notes/$basename
+title="Release $VERSION ($DATE)"
+
+(
+  # TODO add minor number, and append?
+  echo "# $title"
+  echo
+  changelog-d doc/manual/rl-next | sed -e 's/ *$//'
+) > $file
+
+log "Wrote $file"
+
+NEW_SUMMARY_LINE="  - [$title](release-notes/$basename)"
+
+# 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
+
+for f in doc/manual/rl-next/*.md; do
+  if [[ config != "$(basename $f)" ]]; then
+    logcmd git rm $f
+  fi
+done
+
+logcmd git add $file doc/manual/src/SUMMARY.md.in
+logcmd git status
+logcmd git commit -m "release notes: $VERSION"
+
+report_done

From b1ea30f21d24df9afc4eb1635eee9a080e4f81f3 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 19 Nov 2023 18:13:59 +0100
Subject: [PATCH 04/11] scripts/release-notes: Support patch releases

This also fixes the broken case statement, which has globs, not regexes.
---
 maintainers/release-process.md | 24 +++++++++++++
 scripts/release-notes          | 65 ++++++++++++++++++++++++----------
 2 files changed, 71 insertions(+), 18 deletions(-)

diff --git a/maintainers/release-process.md b/maintainers/release-process.md
index e542d8be5..b1259a9bd 100644
--- a/maintainers/release-process.md
+++ b/maintainers/release-process.md
@@ -150,6 +150,30 @@ release:
 
 ## Creating a point release
 
+* Checkout.
+
+  ```console
+  $ git checkout XX.YY-maintenance
+  ```
+
+* Determine the next patch version.
+
+  ```console
+  $ export VERSION=XX.YY.ZZ
+  ```
+
+* Update release notes.
+
+  ```console
+  $ ./scripts/release-notes
+  ```
+
+* Push.
+
+  ```console
+  $ git push
+  ```
+
 * Wait for the desired evaluation of the maintenance jobset to finish
   building.
 
diff --git a/scripts/release-notes b/scripts/release-notes
index e5ee39d11..43f20a547 100755
--- a/scripts/release-notes
+++ b/scripts/release-notes
@@ -89,14 +89,40 @@ if [[ ! -n "${VERSION:-}" ]]; then
   exit 1
 fi
 
-case "$VERSION" in
-  # FIXME: accepts "." without any real digits
-  [[:digit:]]*.[[:digit:]]*)
-    ;;
-  *)
-    die "VERSION must be MAJOR.MINOR, where each is a number, e.g. 2.20 (VERSION was set to $VERSION)"
-    ;;
-esac
+# mutate/initialize:
+# VERSION:      MAJOR.MINOR
+# FULL_VERSION: MAJOR.MINOR.PATCH
+# IS_PATCH:     true if this is a patch release; append instead of create
+if grep -E '^[0-9]+\.[0-9]+$' <<< "$VERSION" >/dev/null; then
+  log 'is minor'
+  IS_PATCH=false
+  FULL_VERSION="$VERSION.0"
+elif grep -E '^[0-9]+\.[0-9]+\.0$' <<< "$VERSION" >/dev/null; then
+  log 'is minor (.0)'
+  IS_PATCH=false
+  FULL_VERSION="$VERSION"
+  VERSION="$(echo "$VERSION" | sed -e 's/\.0$//')"
+elif grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' <<< "$VERSION" >/dev/null; then
+  log 'is patch'
+  IS_PATCH=true
+  FULL_VERSION="$VERSION"
+  VERSION="$(echo "$VERSION" | sed -e 's/\.[0-9]*$//')"
+else
+  die "VERSION must be MAJOR.MINOR[.PATCH], where each is a number, e.g. 2.20 or 2.20.1 (VERSION was set to $VERSION)"
+fi
+
+log "VERSION=$VERSION"
+log "FULL_VERSION=$FULL_VERSION"
+log "IS_PATCH=$IS_PATCH"
+
+basename=rl-$VERSION.md
+file=doc/manual/src/release-notes/$basename
+
+if ! $IS_PATCH; then
+  if [[ -e $file ]]; then
+    die "release notes file $file already exists. If you'd like to make a minor release, pass a patch version, e.g. 2.20.1"
+  fi
+fi
 
 # --- DEFAULTS ---
 
@@ -106,7 +132,7 @@ if [[ ! -n "${DATE:-}" ]]; then
 fi
 
 case "$DATE" in
-  [[:digit:]]*-[[:digit:]]*-[[:digit:]]*)
+  [0-9]*-[0-9]*-[0-9]*)
     ;;
   *)
     die "DATE must be YYYY-MM-DD, e.g. 2021-12-31 (DATE was set to $DATE)"
@@ -115,25 +141,28 @@ esac
 
 # --- DO THE WORK ---
 
-basename=rl-$VERSION.md
-file=doc/manual/src/release-notes/$basename
+# menu
 title="Release $VERSION ($DATE)"
+# section on page
+section_title="Release $FULL_VERSION ($DATE)"
 
 (
   # TODO add minor number, and append?
-  echo "# $title"
+  echo "# $section_title"
   echo
   changelog-d doc/manual/rl-next | sed -e 's/ *$//'
-) > $file
+) | tee -a $file
 
 log "Wrote $file"
 
-NEW_SUMMARY_LINE="  - [$title](release-notes/$basename)"
+if ! $IS_PATCH; then
+  NEW_SUMMARY_LINE="  - [$title](release-notes/$basename)"
 
-# 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
+  # 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
+fi
 
 for f in doc/manual/rl-next/*.md; do
   if [[ config != "$(basename $f)" ]]; then

From 7c4ee5c8135fae65602791f0b89d0dbae7e94f3e Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 19 Nov 2023 18:36:50 +0100
Subject: [PATCH 05/11] scripts/release-notes: Avoid mutating variables

---
 scripts/release-notes | 32 +++++++++++++++++---------------
 1 file changed, 17 insertions(+), 15 deletions(-)

diff --git a/scripts/release-notes b/scripts/release-notes
index 43f20a547..2e1be64a4 100755
--- a/scripts/release-notes
+++ b/scripts/release-notes
@@ -89,33 +89,35 @@ if [[ ! -n "${VERSION:-}" ]]; then
   exit 1
 fi
 
-# mutate/initialize:
-# VERSION:      MAJOR.MINOR
-# FULL_VERSION: MAJOR.MINOR.PATCH
-# IS_PATCH:     true if this is a patch release; append instead of create
+# version_major_minor:      MAJOR.MINOR
+# version_full:             MAJOR.MINOR.PATCH
+# IS_PATCH:                 true if this is a patch release; append instead of create
 if grep -E '^[0-9]+\.[0-9]+$' <<< "$VERSION" >/dev/null; then
   log 'is minor'
   IS_PATCH=false
-  FULL_VERSION="$VERSION.0"
+  version_full="$VERSION.0"
+  version_major_minor="$VERSION"
 elif grep -E '^[0-9]+\.[0-9]+\.0$' <<< "$VERSION" >/dev/null; then
   log 'is minor (.0)'
   IS_PATCH=false
-  FULL_VERSION="$VERSION"
-  VERSION="$(echo "$VERSION" | sed -e 's/\.0$//')"
+  version_full="$VERSION"
+  version_major_minor="$(echo "$VERSION" | sed -e 's/\.0$//')"
 elif grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' <<< "$VERSION" >/dev/null; then
   log 'is patch'
   IS_PATCH=true
-  FULL_VERSION="$VERSION"
-  VERSION="$(echo "$VERSION" | sed -e 's/\.[0-9]*$//')"
+  version_full="$VERSION"
+  version_major_minor="$(echo "$VERSION" | sed -e 's/\.[0-9]*$//')"
 else
   die "VERSION must be MAJOR.MINOR[.PATCH], where each is a number, e.g. 2.20 or 2.20.1 (VERSION was set to $VERSION)"
 fi
 
-log "VERSION=$VERSION"
-log "FULL_VERSION=$FULL_VERSION"
+unset VERSION
+
+log "version_major_minor=$version_major_minor"
+log "version_full=$version_full"
 log "IS_PATCH=$IS_PATCH"
 
-basename=rl-$VERSION.md
+basename=rl-${version_major_minor}.md
 file=doc/manual/src/release-notes/$basename
 
 if ! $IS_PATCH; then
@@ -142,9 +144,9 @@ esac
 # --- DO THE WORK ---
 
 # menu
-title="Release $VERSION ($DATE)"
+title="Release $version_major_minor ($DATE)"
 # section on page
-section_title="Release $FULL_VERSION ($DATE)"
+section_title="Release $version_full ($DATE)"
 
 (
   # TODO add minor number, and append?
@@ -172,6 +174,6 @@ done
 
 logcmd git add $file doc/manual/src/SUMMARY.md.in
 logcmd git status
-logcmd git commit -m "release notes: $VERSION"
+logcmd git commit -m "release notes: $version_full"
 
 report_done

From 6971c4adc06d574cbe1e9ab6da19814e11e2ba6c Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 19 Nov 2023 19:08:42 +0100
Subject: [PATCH 06/11] maintainers/release-notes <- scripts/release-notes

---
 {scripts => maintainers}/release-notes | 0
 maintainers/release-process.md         | 4 ++--
 2 files changed, 2 insertions(+), 2 deletions(-)
 rename {scripts => maintainers}/release-notes (100%)

diff --git a/scripts/release-notes b/maintainers/release-notes
similarity index 100%
rename from scripts/release-notes
rename to maintainers/release-notes
diff --git a/maintainers/release-process.md b/maintainers/release-process.md
index b1259a9bd..db8b064a5 100644
--- a/maintainers/release-process.md
+++ b/maintainers/release-process.md
@@ -28,7 +28,7 @@ release:
 
   ```console
   $ git checkout -b release-notes
-  $ VERSION=X.YY ./scripts/release-notes
+  $ VERSION=X.YY ./maintainers/release-notes
   ```
 
   where `X.YY` is *without* the patch level, e.g. `2.12` rather than ~~`2.12.0`~~.
@@ -165,7 +165,7 @@ release:
 * Update release notes.
 
   ```console
-  $ ./scripts/release-notes
+  $ ./maintainers/release-notes
   ```
 
 * Push.

From 857f9168f7b48aa491052f24fb571c21398f9826 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 24 Nov 2023 15:27:54 +0100
Subject: [PATCH 07/11] Migrate rl-next.md to doc/manual/rl-next directory

---
 doc/manual/rl-next/mounted-ssh-store.md     | 9 +++++++++
 doc/manual/rl-next/nix-env-json-drv-path.md | 9 +++++++++
 doc/manual/src/release-notes/rl-next.md     | 6 ------
 3 files changed, 18 insertions(+), 6 deletions(-)
 create mode 100644 doc/manual/rl-next/mounted-ssh-store.md
 create mode 100644 doc/manual/rl-next/nix-env-json-drv-path.md
 delete mode 100644 doc/manual/src/release-notes/rl-next.md

diff --git a/doc/manual/rl-next/mounted-ssh-store.md b/doc/manual/rl-next/mounted-ssh-store.md
new file mode 100644
index 000000000..39fac5283
--- /dev/null
+++ b/doc/manual/rl-next/mounted-ssh-store.md
@@ -0,0 +1,9 @@
+synopsis: Mounted SSH Store
+issues: #7890
+prs: #7912
+description: {
+
+Introduced the store [`mounted-ssh-ng://`](@docroot@/command-ref/new-cli/nix3-help-stores.md).
+This store allows full access to a Nix store on a remote machine and additionally requires that the store be mounted in the local filesystem.
+
+}
diff --git a/doc/manual/rl-next/nix-env-json-drv-path.md b/doc/manual/rl-next/nix-env-json-drv-path.md
new file mode 100644
index 000000000..fbe2b67d8
--- /dev/null
+++ b/doc/manual/rl-next/nix-env-json-drv-path.md
@@ -0,0 +1,9 @@
+synopsis: Fix `nix-env --query --drv-path --json`
+prs: #9257
+description: {
+
+Fixed a bug where `nix-env --query` ignored `--drv-path` when `--json` was set.
+
+}
+
+
diff --git a/doc/manual/src/release-notes/rl-next.md b/doc/manual/src/release-notes/rl-next.md
deleted file mode 100644
index 0e3d8b462..000000000
--- a/doc/manual/src/release-notes/rl-next.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# Release X.Y (202?-??-??)
-
-- Fixed a bug where `nix-env --query` ignored `--drv-path` when `--json` was set.
-
-- Introduced the store [`mounted-ssh-ng://`](@docroot@/command-ref/new-cli/nix3-help-stores.md).
-  This store allows full access to a Nix store on a remote machine and additionally requires that the store be mounted in the local filesystem.

From d63f72197cec6ff95d9ffc83aa8076acd86a3fd1 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 24 Nov 2023 15:48:41 +0100
Subject: [PATCH 08/11] Don't run changelog-d in the build

This way we lose the preview of release notes on master, as well
as on https://nixos.org/manual/nix/unstable/release-notes/rl-next
but we can come back to this.
---
 doc/manual/local.mk                    | 8 +++++++-
 doc/manual/src/contributing/hacking.md | 2 +-
 flake.nix                              | 9 ++++++---
 3 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/doc/manual/local.mk b/doc/manual/local.mk
index 265a4649d..f22dfa69e 100644
--- a/doc/manual/local.mk
+++ b/doc/manual/local.mk
@@ -146,7 +146,13 @@ $(d)/language.json: $(bindir)/nix
 
 # Generate "Upcoming release" notes (or clear it and remove from menu)
 $(d)/src/release-notes/rl-next.md: $(d)/rl-next $(d)/rl-next/*
-	$(trace-gen) changelog-d doc/manual/rl-next > $@
+	@if type -p changelog-d > /dev/null; then \
+		echo "  GEN   " $@; \
+		changelog-d doc/manual/rl-next > $@; \
+	else \
+		echo "  NULL  " $@; \
+		true > $@; \
+	fi
 
 $(d)/src/SUMMARY-rl-next.md: $(d)/src/release-notes/rl-next.md
 	$(trace-gen) true
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md
index 855900d7a..3291d5a20 100644
--- a/doc/manual/src/contributing/hacking.md
+++ b/doc/manual/src/contributing/hacking.md
@@ -257,4 +257,4 @@ See also the [format documentation](https://github.com/haskell/cabal/blob/master
 ### Build process
 
 Releases have a precomputed `rl-MAJOR.MINOR.md`, and no `rl-next.md`.
-Non-releases build the release notes on the fly.
+Set `buildUnreleasedNotes = true;` in `flake.nix` to build the release notes on the fly.
diff --git a/flake.nix b/flake.nix
index ca37948a7..db913f062 100644
--- a/flake.nix
+++ b/flake.nix
@@ -14,6 +14,9 @@
 
       officialRelease = false;
 
+      # Set to true to build the release notes for the next release.
+      buildUnreleasedNotes = false;
+
       version = lib.fileContents ./.version + versionSuffix;
       versionSuffix =
         if officialRelease
@@ -196,7 +199,7 @@
           ]
           ++ lib.optionals stdenv.hostPlatform.isLinux [(buildPackages.util-linuxMinimal or buildPackages.utillinuxMinimal)]
           # Official releases don't have rl-next, so we don't need to compile a changelog
-          ++ lib.optional (!officialRelease) changelog-d
+          ++ lib.optional (!officialRelease && buildUnreleasedNotes) changelog-d
           ;
 
         buildDeps =
@@ -734,8 +737,8 @@
               ++ lib.optional
                 (stdenv.cc.isClang && stdenv.hostPlatform == stdenv.buildPlatform)
                 pkgs.buildPackages.clang-tools
-              # We want changelog-d in the shell even if it's an official release
-              ++ lib.optional officialRelease changelog-d
+              # We want changelog-d in the shell even if the current build doesn't need it
+              ++ lib.optional (officialRelease || ! buildUnreleasedNotes) changelog-d
               ;
 
             buildInputs = buildDeps ++ propagatedDeps

From c5d49ec7ab7b9fb33f0336a909ac837e208be807 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 24 Nov 2023 16:18:27 +0100
Subject: [PATCH 09/11] flake.lock: Update
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Flake lock file updates:

• Updated input 'nixpkgs':
    'github:NixOS/nixpkgs/decdf666c833a325cb4417041a90681499e06a41' (2023-11-18)
  → 'github:NixOS/nixpkgs/9ba29e2346bc542e9909d1021e8fd7d4b3f64db0' (2023-11-23)
---
 flake.lock | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/flake.lock b/flake.lock
index 1b3c0b6d5..f120d3b5f 100644
--- a/flake.lock
+++ b/flake.lock
@@ -50,11 +50,11 @@
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1700342017,
-        "narHash": "sha256-HaibwlWH5LuqsaibW3sIVjZQtEM/jWtOHX4Nk93abGE=",
+        "lastModified": 1700748986,
+        "narHash": "sha256-/nqLrNU297h3PCw4QyDpZKZEUHmialJdZW2ceYFobds=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "decdf666c833a325cb4417041a90681499e06a41",
+        "rev": "9ba29e2346bc542e9909d1021e8fd7d4b3f64db0",
         "type": "github"
       },
       "original": {

From e7e21aa0c839460a62456fa44f31339c187077ff Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Fri, 24 Nov 2023 16:27:10 +0100
Subject: [PATCH 10/11] flake.nix: Use top level changelog-d

It is about 2 MB now, as only it and libffi (tiny) are new in the
build or shell closures.
---
 flake.nix | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/flake.nix b/flake.nix
index db913f062..a239226c0 100644
--- a/flake.nix
+++ b/flake.nix
@@ -176,9 +176,7 @@
           "--enable-internal-api-docs"
         ];
 
-        # TODO: after backport of https://github.com/NixOS/nixpkgs/pull/268487, remove `haskellPackages.` -
-        #       vastly improves output closure, and adds shell completions
-        changelog-d = pkgs.buildPackages.haskellPackages.changelog-d;
+        changelog-d = pkgs.buildPackages.changelog-d;
 
         nativeBuildDeps =
           [

From f7bfec2806708573798d610cda101f27a24d9218 Mon Sep 17 00:00:00 2001
From: Robert Hensing <roberth@users.noreply.github.com>
Date: Mon, 27 Nov 2023 15:18:29 +0100
Subject: [PATCH 11/11] maintainers/release-notes: Improve DATE check

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
---
 maintainers/release-notes | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/maintainers/release-notes b/maintainers/release-notes
index 2e1be64a4..34cd85a56 100755
--- a/maintainers/release-notes
+++ b/maintainers/release-notes
@@ -134,7 +134,7 @@ if [[ ! -n "${DATE:-}" ]]; then
 fi
 
 case "$DATE" in
-  [0-9]*-[0-9]*-[0-9]*)
+  [0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9])
     ;;
   *)
     die "DATE must be YYYY-MM-DD, e.g. 2021-12-31 (DATE was set to $DATE)"