Skip to content
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

Sync patch release notes back to master periodically? #9396

Open
roberth opened this issue Nov 19, 2023 · 2 comments
Open

Sync patch release notes back to master periodically? #9396

roberth opened this issue Nov 19, 2023 · 2 comments
Assignees
Labels
feature Feature request or proposal process Issues related to the development process of Nix question

Comments

@roberth
Copy link
Member

roberth commented Nov 19, 2023

Is your feature request related to a problem? Please describe.

#9393 makes patch release notes feasible, but users won't be able to find them unless they use the packaged docs of the minor version they're interested in.

Specifically, the release-notes/rl-PP.QQ.md < XX.YY may be out of date for each of

  • master (published)
  • latest maintenance branch (published)
  • other maintenance branches

Unpublished docs also suffer from the issue, so I suggest adding notices and links to "older" release notes sections in the maintenance branches.

Describe the solution you'd like

What I'll propose here is to periodically pull the release notes into master.

Describe alternatives you've considered

a. Push the updated notes to master as part of the patch release process. This is more noise because the updates won't be batched together due to the periodic update.

b. Just put notices in all release-notes/*.md on master, as part of the non-patch release process. This would actually be a good start. We won't be able to direct people with a nice link yet.
- workaround: Point to the markdown files instead?
- workaround: Push docs for all minor releases, e.g. copying into various subdirs in a gh-pages repo, etc.

Additional context

Priorities

Add 👍 to issues you find important.

@roberth roberth added feature Feature request or proposal process Issues related to the development process of Nix labels Nov 19, 2023
@roberth roberth self-assigned this Nov 19, 2023
@roberth roberth changed the title Sync patch release notes back to master periodically Sync patch release notes back to master periodically? Nov 19, 2023
@infinisil
Copy link
Member

Alternative: Have nixos.org render release notes separately from the docs, and link to that separate page from the docs. (And link from the release notes to the docs for that release).

@Ericson2314
Copy link
Member

Not sure if this a related, but we already have a problem that release notes from *-maintenance branches do not make it back to master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Feature request or proposal process Issues related to the development process of Nix question
Projects
None yet
Development

No branches or pull requests

3 participants