Skip to content

Sync patch release notes back to master periodically? #9396

Open
@roberth

Description

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

featureFeature request or proposalprocessIssues related to the development process of Nixquestion

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions