Automatically compile hand-written release notes with `changelog-d` by roberth · Pull Request #9393 · NixOS/nix

roberth · 2023-11-19T14:23:56Z

Motivation

Speed up release process
Self-service principle
Enable release notes for minor releases (backports)
Make writing a note very low friction

Tested manually, including nix build, make, and manually producing the git history in this details section:

Example, git log and git diff

End result (horizontal bars not included)

Release 2.20.0 (2023-11-19)

Significant changes

Add C bindings #1234 #1238

Here's one or more paragraphs that describe the change...
- It's markdown
- Add references to the manual using @docroot@

Other changes

Built-in constants now have :doc support in nix repl #1234 #1238

Example:

nix-repl> :doc builtins.currentSystem

    builtins.currentSystem

    Foo bar baz

Release 2.20.1 (2023-11-19)

C bindings support all store methods #2345

For completeness here's the git log summary

39292ae46dea59d29130d6b28ac029b7d032442d (HEAD -> test-2) release notes: 2.20.1
9745667b6ebeec07a36a47674e045b9cf14ed8f2 C bindings: supprot all store methods
d3da5b66dae04cb9780082478bfcb30031aa94dc release notes: 2.20.0
4d78bceb03ab4270f21d5fb8bde72ed442d6b3e6 nix-repl: Add :doc for constants
f18b6a6cd92d8b9fa211faead10f4c157069531f Add c-bindings

And the log with diffs

commit 39292ae46dea59d29130d6b28ac029b7d032442d
Author: Robert Hensing <[email protected]>
Date:   Sun Nov 19 18:52:10 2023 +0100

    release notes: 2.20.1

diff --git a/doc/manual/rl-next/c-bindings.md b/doc/manual/rl-next/c-bindings.md
deleted file mode 100644
index 5d4b43ff5..000000000
--- a/doc/manual/rl-next/c-bindings.md
+++ /dev/null
@@ -1,2 +0,0 @@
-synopsis: C bindings support all store methods
-prs: #2345
diff --git a/doc/manual/src/release-notes/rl-2.20.md b/doc/manual/src/release-notes/rl-2.20.md
index f0b3f7d20..8df2fd3d6 100644
--- a/doc/manual/src/release-notes/rl-2.20.md
+++ b/doc/manual/src/release-notes/rl-2.20.md
@@ -23,3 +23,6 @@
       Foo bar baz
   ``
 
+# Release 2.20.1 (2023-11-19)
+
+- C bindings support all store methods [#2345](https://github.com/NixOS/nix/pull/2345)

commit 9745667b6ebeec07a36a47674e045b9cf14ed8f2
Author: Robert Hensing <[email protected]>
Date:   Sun Nov 19 18:52:00 2023 +0100

    C bindings: supprot all store methods

diff --git a/doc/manual/rl-next/c-bindings.md b/doc/manual/rl-next/c-bindings.md
new file mode 100644
index 000000000..5d4b43ff5
--- /dev/null
+++ b/doc/manual/rl-next/c-bindings.md
@@ -0,0 +1,2 @@
+synopsis: C bindings support all store methods
+prs: #2345

commit d3da5b66dae04cb9780082478bfcb30031aa94dc
Author: Robert Hensing <[email protected]>
Date:   Sun Nov 19 18:50:11 2023 +0100

    release notes: 2.20.0

diff --git a/doc/manual/rl-next/c-bindings.md b/doc/manual/rl-next/c-bindings.md
deleted file mode 100644
index 28a8ebfc9..000000000
--- a/doc/manual/rl-next/c-bindings.md
+++ /dev/null
@@ -1,12 +0,0 @@
-synopsis: Add C bindings
-issues: #1234
-prs: #1238
-significance: significant
-description: {
-
-Here's one or more paragraphs that describe the change...
-
-- It's markdown
-- Add references to the manual using @docroot@
-
-}
diff --git a/doc/manual/rl-next/doc-constants.md b/doc/manual/rl-next/doc-constants.md
deleted file mode 100644
index b6adc30b4..000000000
--- a/doc/manual/rl-next/doc-constants.md
+++ /dev/null
@@ -1,16 +0,0 @@
-synopsis: Built-in constants now have :doc support in nix repl
-issues: #1234
-prs: #1238
-description: {
-
-Example:
-
-```
-nix-repl> :doc builtins.currentSystem
-
-    builtins.currentSystem
-
-    Foo bar baz
-```
-
-}
diff --git a/doc/manual/src/SUMMARY.md.in b/doc/manual/src/SUMMARY.md.in
index 8e7b4eeab..c2e663a7e 100644
--- a/doc/manual/src/SUMMARY.md.in
+++ b/doc/manual/src/SUMMARY.md.in
@@ -115,6 +115,7 @@
   - [C++ style guide](contributing/cxx.md)
 - [Release Notes](release-notes/release-notes.md)
 {{#include ./SUMMARY-rl-next.md}}
+  - [Release 2.20 (2023-11-19)](release-notes/rl-2.20.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)
diff --git a/doc/manual/src/release-notes/rl-2.20.md b/doc/manual/src/release-notes/rl-2.20.md
new file mode 100644
index 000000000..f0b3f7d20
--- /dev/null
+++ b/doc/manual/src/release-notes/rl-2.20.md
@@ -0,0 +1,25 @@
+# Release 2.20.0 (2023-11-19)
+
+### Significant changes
+
+- Add C bindings [#1234](https://github.com/NixOS/nix/issues/1234) [#1238](https://github.com/NixOS/nix/pull/1238)
+
+  Here's one or more paragraphs that describe the change...
+
+  - It's markdown
+  - Add references to the manual using @docroot@
+
+### Other changes
+
+- Built-in constants now have :doc support in nix repl [#1234](https://github.com/NixOS/nix/issues/1234) [#1238](https://github.com/NixOS/nix/pull/1238)
+
+  Example:
+
+  ```
+  nix-repl> :doc builtins.currentSystem
+
+      builtins.currentSystem
+
+      Foo bar baz
+  ```
+

commit 4d78bceb03ab4270f21d5fb8bde72ed442d6b3e6
Author: Robert Hensing <[email protected]>
Date:   Sun Nov 19 18:49:43 2023 +0100

    nix-repl: Add :doc for constants

diff --git a/doc/manual/rl-next/doc-constants.md b/doc/manual/rl-next/doc-constants.md
new file mode 100644
index 000000000..b6adc30b4
--- /dev/null
+++ b/doc/manual/rl-next/doc-constants.md
@@ -0,0 +1,16 @@
+synopsis: Built-in constants now have :doc support in nix repl
+issues: #1234
+prs: #1238
+description: {
+
+Example:
+
+```
+nix-repl> :doc builtins.currentSystem
+
+    builtins.currentSystem
+
+    Foo bar baz
+```
+
+}

commit f18b6a6cd92d8b9fa211faead10f4c157069531f
Author: Robert Hensing <[email protected]>
Date:   Sun Nov 19 17:40:07 2023 +0100

    Add c-bindings

diff --git a/doc/manual/rl-next/c-bindings.md b/doc/manual/rl-next/c-bindings.md
new file mode 100644
index 000000000..28a8ebfc9
--- /dev/null
+++ b/doc/manual/rl-next/c-bindings.md
@@ -0,0 +1,12 @@
+synopsis: Add C bindings
+issues: #1234
+prs: #1238
+significance: significant
+description: {
+
+Here's one or more paragraphs that describe the change...
+
+- It's markdown
+- Add references to the manual using @docroot@
+
+}

Context

Includes flake.nix: Update nixpkgs: release-23.05 -> nixos-23.05-small #9386
Closes Release notes automation #7665

Priorities

Add 👍 to pull requests you find important.

fricklerhandwerk

All the Bash: Not great, not terrible. Conflict-free release notes: nice.

maintainers/release-process.md

fricklerhandwerk · 2023-11-19T21:08:56Z

maintainers/release-process.md

+* Update release notes.
+
+  ```console
+  $ ./maintainers/release-notes


This could be one line like above

Suggested change

$ ./maintainers/release-notes

$ VERSION=X.YY.ZZ ./maintainers/release-notes

I think Eelco would have exported here in practice, while in the other place that's even less obvious.
I'm fine either way. Maybe @edolstra could decide?

roberth · 2023-11-19T21:19:17Z

All the Bash: Not great, not terrible.

It's cheap and gets the job done quite well. Crucially it's not critical, and the mutation has safeguards:

maintainers/release-notes requires a clean worktree, so no info is lost
maintainers/add-release-note checks that it doesn't overwrite

roberth · 2023-11-19T21:20:00Z

If we're happy about the behavior we may consider upstreaming it into changelog-d to get rid of the bash.

fricklerhandwerk · 2023-11-24T13:25:16Z

.github/PULL_REQUEST_TEMPLATE.md

+-----
+
+> [!TIP]
+> Making a user facing change? `$ maintainers/add-release-note` :rocket:


Probably not a good place for it. We have a checklist in the contributor guide.

fricklerhandwerk · 2023-11-24T13:43:56Z

Triaged in Nix team meeting:

@fricklerhandwerk: could imagine something a bit simpler and more flexible (for the user) for the convenience script, such as $EDITOR $(mktemp) and process the result to create a file with the right name in the right place
- @roberth: could also skip the script if it causes disagreement
@edolstra: worried about pulling GHC into the build time closure
- @roberth: usually only the program itself will be fetched, a couple of MiB
@edolstra: why can't we just cat?
- @roberth: it does a bit of not-entirely-trivial processing, see PR description
- @fricklerhandwerk: also inclined to do something dumber
- @roberth: that would ignore work done by other communities, not interested in re-inventing the wheel
@roberth: the syntax is a bit Cabal-flavored, which is not great, but close enough
@fricklerhandwerk: should not overthink it, we can change the creation process in the future
decision: idea approved, but leave out the helper script for now and don't run it in the build by default

This also fixes the broken case statement, which has globs, not regexes.

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.

Flake lock file updates: • Updated input 'nixpkgs': 'github:NixOS/nixpkgs/decdf666c833a325cb4417041a90681499e06a41' (2023-11-18) → 'github:NixOS/nixpkgs/9ba29e2346bc542e9909d1021e8fd7d4b3f64db0' (2023-11-23)

It is about 2 MB now, as only it and libffi (tiny) are new in the build or shell closures.

fricklerhandwerk

Nice!

maintainers/release-notes

Co-authored-by: Valentin Gagarin <[email protected]>

Automatically compile hand-written release notes with `changelog-d` (cherry picked from commit 928f0c1) Change-Id: Ia0685835c52edf185b64dd696b19305746c077e5

github-actions bot added the documentation label Nov 19, 2023

roberth added the process Issues related to the development process of Nix label Nov 19, 2023

roberth force-pushed the changelog-d branch 2 times, most recently from 11c8dcb to 6e3e87d Compare November 19, 2023 18:05

roberth marked this pull request as ready for review November 19, 2023 19:05

roberth requested review from edolstra and fricklerhandwerk as code owners November 19, 2023 19:05

roberth added the contributor-experience Developer experience for Nix contributors label Nov 19, 2023

roberth mentioned this pull request Nov 19, 2023

Sync patch release notes back to master periodically? #9396

Open

fricklerhandwerk approved these changes Nov 19, 2023

View reviewed changes

fricklerhandwerk reviewed Nov 24, 2023

View reviewed changes

fricklerhandwerk added the idea approved The given proposal has been discussed and approved by the Nix team. An implementation is welcome. label Nov 24, 2023

fricklerhandwerk self-assigned this Nov 24, 2023

This comment was marked as duplicate.

Sign in to view

roberth added 2 commits November 24, 2023 15:13

Compile hand-written release notes with changelog-d

b798237

doc: Rename 2X.XX to "Upcoming release", and only generate if applicable

b26038c

This comment was marked as resolved.

Sign in to view

roberth force-pushed the changelog-d branch 2 times, most recently from cd44198 to 7f20da6 Compare November 24, 2023 15:30

This comment was marked as resolved.

Sign in to view

roberth added 5 commits November 24, 2023 16:53

Add scripts/release-notes

2a538c5

scripts/release-notes: Support patch releases

b1ea30f

This also fixes the broken case statement, which has globs, not regexes.

scripts/release-notes: Avoid mutating variables

7c4ee5c

maintainers/release-notes <- scripts/release-notes

6971c4a

Migrate rl-next.md to doc/manual/rl-next directory

857f916

roberth force-pushed the changelog-d branch from 7f20da6 to f92e913 Compare November 24, 2023 15:53

Don't run changelog-d in the build

d63f721

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.

roberth added 2 commits November 26, 2023 21:21

flake.lock: Update

c5d49ec

Flake lock file updates: • Updated input 'nixpkgs': 'github:NixOS/nixpkgs/decdf666c833a325cb4417041a90681499e06a41' (2023-11-18) → 'github:NixOS/nixpkgs/9ba29e2346bc542e9909d1021e8fd7d4b3f64db0' (2023-11-23)

flake.nix: Use top level changelog-d

e7e21aa

It is about 2 MB now, as only it and libffi (tiny) are new in the build or shell closures.

roberth force-pushed the changelog-d branch from f92e913 to e7e21aa Compare November 26, 2023 20:22

roberth requested a review from fricklerhandwerk November 26, 2023 20:22

fricklerhandwerk approved these changes Nov 26, 2023

View reviewed changes

maintainers/release-notes Outdated Show resolved Hide resolved

maintainers/release-notes: Improve DATE check

f7bfec2

Co-authored-by: Valentin Gagarin <[email protected]>

roberth enabled auto-merge November 27, 2023 14:18

roberth merged commit 928f0c1 into NixOS:master Nov 27, 2023

roberth mentioned this pull request Nov 27, 2023

Evaluate nix-shell -i args relative to script #5088

Merged

roberth mentioned this pull request Dec 9, 2023

changelog-d rejects { in description #9566

Closed

infinisil mentioned this pull request Apr 9, 2024

Version and changelog NixOS/nixpkgs-vet#38

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

Automatically compile hand-written release notes with `changelog-d`#9393

Automatically compile hand-written release notes with `changelog-d`#9393
roberth merged 11 commits intoNixOS:masterfrom
hercules-ci:changelog-d

roberth commented Nov 19, 2023 •

edited

Loading

Uh oh!

fricklerhandwerk left a comment

Uh oh!

Uh oh!

fricklerhandwerk Nov 19, 2023

Uh oh!

roberth Nov 19, 2023

Uh oh!

roberth commented Nov 19, 2023

Uh oh!

roberth commented Nov 19, 2023

Uh oh!

fricklerhandwerk Nov 24, 2023

Uh oh!

fricklerhandwerk commented Nov 24, 2023

Uh oh!

This comment was marked as duplicate.

This comment was marked as resolved.

This comment was marked as resolved.

fricklerhandwerk left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	$ ./maintainers/release-notes
	$ VERSION=X.YY.ZZ ./maintainers/release-notes

Uh oh!

Comments

Conversation

roberth commented Nov 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Release 2.20.0 (2023-11-19)

Significant changes

Other changes

Release 2.20.1 (2023-11-19)

Context

Priorities

Uh oh!

fricklerhandwerk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fricklerhandwerk Nov 19, 2023

Choose a reason for hiding this comment

Uh oh!

roberth Nov 19, 2023

Choose a reason for hiding this comment

Uh oh!

roberth commented Nov 19, 2023

Uh oh!

roberth commented Nov 19, 2023

Uh oh!

fricklerhandwerk Nov 24, 2023

Choose a reason for hiding this comment

Uh oh!

fricklerhandwerk commented Nov 24, 2023

Uh oh!

This comment was marked as duplicate.

This comment was marked as resolved.

This comment was marked as resolved.

fricklerhandwerk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

roberth commented Nov 19, 2023 •

edited

Loading