From a8bce24908b4546936b416bae175b124c391a720 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 17 Jul 2024 08:51:20 +0200 Subject: [PATCH] docs: Add docs about resolving gitflow merge conflicts (#12936) This adds docs about how to resolve gitflow merge conflicts. --------- Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com> --- docs/gitflow.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/gitflow.md b/docs/gitflow.md index 8926c614bcfc..8bc853e8dbf0 100644 --- a/docs/gitflow.md +++ b/docs/gitflow.md @@ -18,3 +18,16 @@ We use [Gitflow](https://docs.github.com/en/get-started/quickstart/github-flow) While a release is pending, we may merge anything into develop, **except for changes to package.json files**. If we change the package.json files on develop, the gitflow PR master -> develop will have merge conflicts, because during the release the package.json files are updated on master. + +## What to do if there is a merge conflict? + +Although gitflow should help us to avoid merge conflicts, as mentioned above in "Important Caveats" it can still happen +that you get a merge conflict when trying to merge master into develop after a successful release. + +If this happen, you can resolve this as follows: + +- Close the automated PR that was created by the gitflow automation +- Create a new branch on top of `master` (e.g. `manual-develop-sync`) +- Merge `develop` into this branch, with a merge commit (and fix any merge conflicts that come up) +- Now create a PR against `develop` from your branch (e.g. `manual-develop-sync`) +- Merge this PR with a merge commit