maintainers/release-notes: Include changelog-d

Otherwise it quietly generates an empty rl-<version>.md
This commit is contained in:
Eelco Dolstra 2024-01-29 17:10:42 +01:00
parent 1ef6bbb16d
commit 0070400809
4 changed files with 3 additions and 19 deletions

View file

@ -304,7 +304,6 @@ See also the [format documentation](https://github.com/haskell/cabal/blob/master
### Build process ### Build process
Releases have a precomputed `rl-MAJOR.MINOR.md`, and no `rl-next.md`. Releases have a precomputed `rl-MAJOR.MINOR.md`, and no `rl-next.md`.
Set `buildUnreleasedNotes = true;` in `flake.nix` to build the release notes on the fly.
## Branches ## Branches

View file

@ -190,7 +190,6 @@
boehmgc = final.boehmgc-nix; boehmgc = final.boehmgc-nix;
libgit2 = final.libgit2-nix; libgit2 = final.libgit2-nix;
busybox-sandbox-shell = final.busybox-sandbox-shell or final.default-busybox-sandbox-shell; busybox-sandbox-shell = final.busybox-sandbox-shell or final.default-busybox-sandbox-shell;
changelog-d = final.changelog-d-nix;
} // { } // {
# this is a proper separate downstream package, but put # this is a proper separate downstream package, but put
# here also for back compat reasons. # here also for back compat reasons.
@ -363,7 +362,7 @@
}); });
packages = forAllSystems (system: rec { packages = forAllSystems (system: rec {
inherit (nixpkgsFor.${system}.native) nix; inherit (nixpkgsFor.${system}.native) nix changelog-d-nix;
default = nix; default = nix;
} // (lib.optionalAttrs (builtins.elem system linux64BitSystems) { } // (lib.optionalAttrs (builtins.elem system linux64BitSystems) {
nix-static = nixpkgsFor.${system}.static.nix; nix-static = nixpkgsFor.${system}.static.nix;

View file

@ -1,7 +1,5 @@
#!/usr/bin/env nix-shell #!/usr/bin/env nix
#!nix-shell -i bash ../shell.nix -I nixpkgs=channel:nixos-unstable-small #!nix shell .#changelog-d-nix --command bash
# ^^^^^^^
# Only used for bash. shell.nix goes to the flake.
# --- CONFIGURATION --- # --- CONFIGURATION ---

View file

@ -10,7 +10,6 @@
, boost , boost
, brotli , brotli
, bzip2 , bzip2
, changelog-d
, curl , curl
, editline , editline
, readline , readline
@ -88,11 +87,6 @@
# - readline # - readline
, readlineFlavor ? if stdenv.hostPlatform.isWindows then "readline" else "editline" , readlineFlavor ? if stdenv.hostPlatform.isWindows then "readline" else "editline"
# Whether to compile `rl-next.md`, the release notes for the next
# not-yet-released version of Nix in the manul, from the individual
# change log entries in the directory.
, buildUnreleasedNotes ? false
# Whether to build the internal API docs, can be done separately from # Whether to build the internal API docs, can be done separately from
# everything else. # everything else.
, enableInternalAPIDocs ? false , enableInternalAPIDocs ? false
@ -218,9 +212,6 @@ in {
] ++ lib.optionals (doInstallCheck || enableManual) [ ] ++ lib.optionals (doInstallCheck || enableManual) [
jq # Also for custom mdBook preprocessor. jq # Also for custom mdBook preprocessor.
] ++ lib.optional stdenv.hostPlatform.isLinux util-linux ] ++ lib.optional stdenv.hostPlatform.isLinux util-linux
# Official releases don't have rl-next, so we don't need to compile a
# changelog
++ lib.optional (!officialRelease && buildUnreleasedNotes) changelog-d
++ lib.optional enableInternalAPIDocs doxygen ++ lib.optional enableInternalAPIDocs doxygen
; ;
@ -378,9 +369,6 @@ in {
# Nix proper (which they depend on). # Nix proper (which they depend on).
(installUnitTests -> doBuild) (installUnitTests -> doBuild)
(doCheck -> doBuild) (doCheck -> doBuild)
# We have to build the manual to build unreleased notes, as those
# are part of the manual
(buildUnreleasedNotes -> enableManual)
# The build process for the manual currently requires extracting # The build process for the manual currently requires extracting
# data from the Nix executable we are trying to document. # data from the Nix executable we are trying to document.
(enableManual -> doBuild) (enableManual -> doBuild)