From 428d44b2fd272603f875e57daafc088e0bd98d4e Mon Sep 17 00:00:00 2001 From: Jonathan Ringer Date: Wed, 2 Jun 2021 13:33:46 -0700 Subject: [PATCH 1/2] .github/CONTRIBUTING.md: Add 21.11 release-notes steps --- .github/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bc43f80a060..76bf94785f2 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -59,6 +59,16 @@ Follow these steps to backport a change into a release branch in compliance with 5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-20.09`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[20.09]`. 6. When the backport pull request is merged and you have the necessary privileges you can also replace the label `9.needs: port to stable` with `8.has: port to stable` on the original pull request. This way maintainers can keep track of missing backports easier. +## Generating 21.11 Release Notes + +Documentation in nixpkgs is transitioning to a markdown-centric workflow. Release notes now require a translation step to convert from markdown to a compatible docbook document. + +Steps for updating 21.11 Release notes: + +1. Edit `nixos/doc/manual/release-notes/rl-2111.section.md` with the desired changes +2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2111.section.xml` +3. Include changes to `rl-2111.section.md` and `rl-2111.section.xml` in the same commit. + ## Reviewing contributions See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions). From 291dcac8303cd0d458a77d69dbb7e7ffab29aa34 Mon Sep 17 00:00:00 2001 From: Jonathan Ringer Date: Wed, 2 Jun 2021 13:21:56 -0700 Subject: [PATCH 2/2] pull_request_template: Add release note criteria --- .github/PULL_REQUEST_TEMPLATE.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 73783432037..027ac76df46 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,5 +23,8 @@ Reviewing guidelines: https://nixos.org/manual/nixpkgs/unstable/#chap-reviewing- - [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) - [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review wip"` - [ ] Tested execution of all binary files (usually in `./result/bin/`) -- [ ] Added a release notes entry if the change is major or breaking +- [21.11 Release Notes](./CONTRIBUTING.md#generating-2111-release-notes) + - [ ] (Package updates) Added a release notes entry if the change is major or breaking + - [ ] (Module updates) Added a release notes entry if the change is significant + - [ ] (Module addition) Added a release notes entry if adding a new NixOS module - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).