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

Add git merge as a way to update feature branches #2512

Merged
merged 3 commits into from
Feb 28, 2025
Merged
Changes from 2 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
33 changes: 15 additions & 18 deletions docs/development_catching_up.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,41 @@
title: "Catching up with reality"
---

If it's taking a while to develop your feature, and you want to catch up with what's in the current Home Assistant `dev` branch, you can use `git rebase`. This will pull the latest Home Assistant changes locally, rewind your commits, bring in the latest changes from Home Assistant, and replay all of your commits on top.
If it's taking a while to develop your feature, and you want to catch up with what's in the current Home Assistant `dev` branch, you can either use `git merge` or `git rebase`.
Bellow you can find instructions on how to do it using `git merge`. This will pull the latest Home Assistant changes locally, and merge them into your branch by creating a merge commit.

:::tip
If you use the workflow below, it is important that you force push the update as described. Git might prompt you to do `git pull` first. Do **NOT** do that! It would mess up your commit history.
:::

You should have added an additional `remote` after you clone your fork. If you did not, do it now before proceeding.
You should have added an additional `remote` after you clone your fork. If you did not, do it now before proceeding:

```shell
git remote add upstream https://github.com/home-assistant/core.git
```

```shell
# Run this from your feature branch
git fetch upstream dev # to pull the latest changes into a local dev branch
git rebase upstream/dev # to put those changes into your feature branch before your changes
git fetch upstream dev # to fetch the latest changes into a local dev branch
git merge upstream/dev # to put those changes into your feature branch before your changes
```

If rebase detects conflicts, repeat this process until all changes have been resolved:
If git detects any conflicts do the following to solve them:

1. `git status` shows you the file with the conflict; edit the file and resolve the lines between `<<<< | >>>>`
1. Use `git status` to see the file with the conflict; edit the file and resolve the lines between `<<<< | >>>>`
2. Add the modified file: `git add <file>` or `git add .`
3. Continue rebase: `git rebase --continue`
4. Repeat until you've resolved all conflicts
3. Finish the merge by commiting it (you can leave the default merge commit message unchanged): `git commit`

After rebasing your branch, you will have rewritten history relative to your GitHub fork's branch. When you go to push you will see an error that your history has diverged from the original branch. In order to get your GitHub fork up-to-date with your local branch, you will need to force push, using the following command:
Finally, just push your changes as normal:

```shell
# Run this from your feature branch
git push origin --force-with-lease
git push
```

If that command fails, it means that new work was pushed to the branch from either you or another contributor since your last rebase.
You will have to start over the git fetch and rebase process described above, or if you are really confident those changes are not needed, just overwrite them:
If that command fails, it means that new work was pushed to the branch from either you or another contributor since your last update. In that case, just pull them into your local branch, solve any conflicts and push everything again:

```shell
# Run this from your feature branch, overwriting any changes in the remote branch
git push origin --force
# Run this from your feature branch
git pull --no-rebase
git push
```


Other workflows are covered in detail in the [Github documentation](https://docs.github.com/get-started/quickstart/fork-a-repo).