summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorArnout Engelen <arnout@bzzt.net>2022-05-28 12:58:40 +0200
committerArnout Engelen <arnout@bzzt.net>2022-05-28 13:58:31 +0200
commitd73290c6dd70a0f84a8464dc2b8cc159abf1d0b4 (patch)
treeda91d66cb20d64d57d4fb2aa8674496d9ec0ca01 /CONTRIBUTING.md
parent83658b28fe638a170a19b8933aa008b30640fbd1 (diff)
CONTRIBUTING.md: document using labels for backporting
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b90598e679119..46e3ea5b22401 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -97,6 +97,12 @@ git push origin $(git branch --show-current) --force-with-lease
 
 Follow these steps to backport a change into a release branch in compliance with the [commit policy](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches).
 
+You can add a label such as `backport release-22.05` to a PR, so that merging it will
+automatically create a backport (via [a GitHub Action](.github/workflows/backport.yml)).
+This also works for PR's that have already been merged, and might take a couple of minutes to trigger.
+
+You can also create the backport manually:
+
 1. Take note of the commits in which the change was introduced into `master` branch.
 2. Check out the target _release branch_, e.g. `release-21.11`. Do not use a _channel branch_ like `nixos-21.11` or `nixpkgs-21.11-darwin`.
 3. Create a branch for your change, e.g. `git checkout -b backport`.