Skip to content

Commit

Permalink
maintainers/release-notes: Include changelog-d
Browse files Browse the repository at this point in the history
Otherwise it quietly generates an empty rl-<version>.md
  • Loading branch information
edolstra committed Jan 29, 2024
1 parent 1ef6bbb commit 0070400
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 19 deletions.
1 change: 0 additions & 1 deletion doc/manual/src/contributing/hacking.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,6 @@ 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`.
Set `buildUnreleasedNotes = true;` in `flake.nix` to build the release notes on the fly.

## Branches

Expand Down
3 changes: 1 addition & 2 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,6 @@
boehmgc = final.boehmgc-nix;
libgit2 = final.libgit2-nix;
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
# here also for back compat reasons.
Expand Down Expand Up @@ -363,7 +362,7 @@
});

packages = forAllSystems (system: rec {
inherit (nixpkgsFor.${system}.native) nix;
inherit (nixpkgsFor.${system}.native) nix changelog-d-nix;
default = nix;
} // (lib.optionalAttrs (builtins.elem system linux64BitSystems) {
nix-static = nixpkgsFor.${system}.static.nix;
Expand Down
6 changes: 2 additions & 4 deletions maintainers/release-notes
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
#!/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.
#!/usr/bin/env nix
#!nix shell .#changelog-d-nix --command bash

# --- CONFIGURATION ---

Expand Down
12 changes: 0 additions & 12 deletions package.nix
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
, boost
, brotli
, bzip2
, changelog-d
, curl
, editline
, readline
Expand Down Expand Up @@ -88,11 +87,6 @@
# - readline
, 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
# everything else.
, enableInternalAPIDocs ? false
Expand Down Expand Up @@ -218,9 +212,6 @@ in {
] ++ lib.optionals (doInstallCheck || enableManual) [
jq # Also for custom mdBook preprocessor.
] ++ 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
;

Expand Down Expand Up @@ -378,9 +369,6 @@ in {
# Nix proper (which they depend on).
(installUnitTests -> 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
# data from the Nix executable we are trying to document.
(enableManual -> doBuild)
Expand Down

0 comments on commit 0070400

Please sign in to comment.