From 47c2f90d2dc67de8abaa0ceb03ce3b105e196d96 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Tue, 16 Jul 2024 16:58:53 +0200 Subject: [PATCH 1/3] docs: Add docs about resolving gitflow merge conflicts --- docs/gitflow.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/gitflow.md b/docs/gitflow.md index 8926c614bcfc..8f058eb1a597 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 automationxw +- Create a new branch on top of `master` (e.g. `manual-develop-sync`) +- Merge `develop` into this branch, with a merge commit +- Now create a PR against `develop` from your branch (e.g. `manual-develop-sync`) +- Merge this PR with a merge commit From 2168fa50a601be85d7c710fc298eafd1a12ce347 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Tue, 16 Jul 2024 17:03:25 +0200 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com> --- docs/gitflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gitflow.md b/docs/gitflow.md index 8f058eb1a597..7f7cc8442cdf 100644 --- a/docs/gitflow.md +++ b/docs/gitflow.md @@ -26,7 +26,7 @@ that you get a merge conflict when trying to merge master into develop after a s If this happen, you can resolve this as follows: -- Close the automated PR that was created by the gitflow automationxw +- 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 - Now create a PR against `develop` from your branch (e.g. `manual-develop-sync`) From a65081cfbef3722eabff35af7ecebd907467ae20 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Tue, 16 Jul 2024 17:03:50 +0200 Subject: [PATCH 3/3] update --- docs/gitflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gitflow.md b/docs/gitflow.md index 7f7cc8442cdf..8bc853e8dbf0 100644 --- a/docs/gitflow.md +++ b/docs/gitflow.md @@ -28,6 +28,6 @@ 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 +- 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