Skip to content

Commit

Permalink
docs: Fix formatting bug (grafana#14633)
Browse files Browse the repository at this point in the history
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit f5b5e71)
  • Loading branch information
jdbaldry authored and JStickler committed Oct 29, 2024
1 parent df8b0ec commit 25f3584
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/sources/community/maintaining/release/backport-commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Backport commits
description: Backport commits
---

# Backport commits

Any PRs or commits not on the release branch that you want to include in the release must be backported to the release branch.
Expand All @@ -19,12 +20,16 @@ Any PRs or commits not on the release branch that you want to include in the rel
1. Add two labels to the PR. First, one of the `product-approved`, `type/doc` or `type/bug` appropriately. This is to make sure the PRs that are backported are done with right intention. Second `backport release-VERSION_PREFIX` label.
Now CI should automatically create backport PR to the correct release branch. Example [PR](https://github.com/grafana/loki/pull/10333)

{{% admonition type="note" %}}
CI automation can fail sometimes if there are some merge conflicts in cherry picking the commits. In those cases, the original PR where you added the label should have additional comment explaining how to backport it manually.
{{% /admonition %}}
{{< admonition type="note" >}}
CI automation can fail sometimes if there are some merge conflicts in cherry picking the commits. In those cases, the original PR where you added the label should have additional comment explaining how to backport it manually.
{{< /admonition >}}

{{% admonition type="note" %}}
The CI job that helps with backporting PR is `.github/workflows/backport.yml`. Useful for debugging purposes.
{{% /admonition %}}
{{< admonition type="note" >}}
The CI job that helps with backporting PR is `.github/workflows/backport.yml`. Useful for debugging purposes.
{{< /admonition >}}

1. Repeat the above steps for any PRs that need to be backported.

## Backporting Release PRs

If backporting a release PR, make sure you remove any `autorelease: pending` or `autorelease: tagged` labels before merging the backport PR. By default our backport action brings over all labels, but these labels are reserved for the release workflow and will cause future pipelines to fail if left of backport PRs.

0 comments on commit 25f3584

Please sign in to comment.