Skip to content

docs: Add docs about resolving gitflow merge conflicts #12936

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

Merged
merged 3 commits into from
Jul 17, 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
13 changes: 13 additions & 0 deletions docs/gitflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading