From e37ee16d594fba390b74301dd1bc811212c5d6b2 Mon Sep 17 00:00:00 2001 From: Jelte Fennema Date: Mon, 12 Jun 2023 10:42:26 +0200 Subject: [PATCH] Add a section on backporting to CONTRIBUTING.md (#6995) Backporting changes is pretty easy, but the steps are not obvious if you're new to the project. --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cff39bf51..010842a5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -219,6 +219,18 @@ style `#include` statements like this: Any other SQL you can put directly in the main sql file, e.g. `src/backend/distributed/sql/citus--8.3-1--9.0-1.sql`. +### Backporting a commit to a release branch + +1. Check out the release branch that you want to backport to `git checkout release-11.3` +2. Make sure you have the latest changes `git pull` +3. Create a new release branch with a unique name `git checkout release-11.3-` +4. Cherry-pick the commit that you want to backport `git cherry-pick -x ` (the `-x` is important) +5. Push the branch `git push` +6. Wait for tests to pass +7. If the cherry-pick required non-trivial merge conflicts, create a PR and ask + for a review. +8. After the tests pass on CI, fast-forward the release branch `git push origin release-11.3-:release-11.3` + ### Running tests See [`src/test/regress/README.md`](https://github.com/citusdata/citus/blob/master/src/test/regress/README.md)