Skip to content

Commit b56b2a4

Browse files
mdellwegdralley
authored andcommitted
Improve cherry-pick docs
1 parent d38cd91 commit b56b2a4

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

docs/dev/guides/pull-request-walkthrough.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,25 @@ If in doubt, ask on the original issue or PR.
3232

3333
## To Cherry-Pick or Not
3434

35-
Usually, a bugfix for a bug found in a released version of Pulp should be backported.
36-
If backporting to a specific branch, all supported branches inbetween must receive the backport too.
35+
Sometimes, a bugfix for a bug found in a released version of Pulp should be backported.
36+
This can be because it is requested by downstream products, or because we decide the severity warrants for that.
37+
We only release patch releases on a small set of _supported branches_ we define in the `template_config.yml`.
38+
If backporting to one of these branches, all supported branches in between must receive the backport too.
3739
This is necessary to prevent regressions on the just fixed bug on updating.
3840

3941
!!! warning
4042
Database migrations cannot be backported.
4143

4244
You can trigger `patchback` to automatically attempt to cherry-pick a single-commit pull-request after merging.
45+
46+
!!! warning
47+
`patchback` only operates correctly on merged pull requests with exactly one commit.
48+
This should be the case for a usual bugfix PR. If not, manually backporting is needed.
49+
4350
This is accomplished by applying the corresponding label, e.g. `backport-3.18`.
4451
If you do not have permission to add the labels, feel free to ask on the pull request.
4552
In case this fails, you are usually presented the appropriate set of commands to followup manually.
53+
Please make sure that the changelog entry for your bugfix is backported along.
4654

4755
!!! note
4856
These backport labels are generated automatically to always reflect the currently supported branches.

0 commit comments

Comments
 (0)