Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Add example of backporting / cherry-picking to release branch #13565

Merged
merged 2 commits into from
Nov 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion dev/release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Patch releases are made on an adhoc basis, but we try and avoid them given the f
- Once the PR is approved and merged, we tag the rc in the release branch, and release from the release branch
- Bug fixes can be merged to the release branch and patch releases can be created from the release branch

#### How to add changes to `branch-*` branch?
#### How to backport (add changes) to `branch-*` branch

If you would like to propose your change for inclusion in a release branch for a
patch release:
Expand All @@ -39,6 +39,16 @@ patch release:
1. Follow normal workflow to create PR to `main` branch and wait for its approval and merge.
1. After PR is squash merged to `main`, branch from most recent release branch (e.g. `branch-37`), cherry-pick the commit and create a PR targeting the release branch [example backport PR].

For example, to backport commit `12345` from `main` to `branch-43`:

```shell
git checkout branch-43
git checkout -b backport_to_43
git cherry-pick 12345
git push -u <your fork>
# make a PR as normal
```

[example release issue]: https://github.com/apache/datafusion/issues/9904
[example backport pr]: https://github.com/apache/datafusion/pull/10123

Expand Down