-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automatically compile hand-written release notes with changelog-d
#9393
Conversation
11c8dcb
to
6e3e87d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the Bash: Not great, not terrible. Conflict-free release notes: nice.
* Update release notes. | ||
|
||
```console | ||
$ ./maintainers/release-notes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be one line like above
$ ./maintainers/release-notes | |
$ VERSION=X.YY.ZZ ./maintainers/release-notes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
It's cheap and gets the job done quite well. Crucially it's not critical, and the mutation has safeguards:
|
If we're happy about the behavior we may consider upstreaming it into |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
----- | ||
|
||
> [!TIP] | ||
> Making a user facing change? `$ maintainers/add-release-note` :rocket: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably not a good place for it. We have a checklist in the contributor guide.
Triaged in Nix team meeting:
|
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as resolved.
This comment was marked as resolved.
cd44198
to
7f20da6
Compare
This comment was marked as resolved.
This comment was marked as resolved.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Co-authored-by: Valentin Gagarin <[email protected]>
Automatically compile hand-written release notes with `changelog-d` (cherry picked from commit 928f0c1) Change-Id: Ia0685835c52edf185b64dd696b19305746c077e5
Motivation
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...
Other changes
Built-in constants now have :doc support in nix repl #1234 #1238
Example:
Release 2.20.1 (2023-11-19)
For completeness here's the git log summary
And the log with diffs
Context
Priorities
Add 👍 to pull requests you find important.