jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-19 15:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* Add git merge as a way to update feature branches

* Remove rebase instructions
This commit is contained in:
Abílio Costa 2025-02-28 12:44:32 +00:00 committed by GitHub
parent 0eb93417d2
commit 970a4de40c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/development_catching_up.md
View File

@ -2,13 +2,10 @@
title: "Catching up with reality" 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 You should have added an additional `remote` after you clone your fork. If you did not, do it now before proceeding:
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.
```shell ```shell
git remote add upstream https://github.com/home-assistant/core.git git remote add upstream https://github.com/home-assistant/core.git
@ -16,30 +13,30 @@ git remote add upstream https://github.com/home-assistant/core.git
```shell ```shell
# Run this from your feature branch # Run this from your feature branch
git fetch upstream dev # to pull the latest changes into a local dev branch git fetch upstream dev # to fetch the latest changes into a local dev branch
git rebase upstream/dev # to put those changes into your feature branch before your changes 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 .` 2. Add the modified file: `git add <file>` or `git add .`
3. Continue rebase: `git rebase --continue` 3. Finish the merge by commiting it (you can leave the default merge commit message unchanged): `git commit`
4. Repeat until you've resolved all conflicts
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 ```shell
# Run this from your feature branch # 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. 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:
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:
```shell ```shell
# Run this from your feature branch, overwriting any changes in the remote branch # Run this from your feature branch
git push origin --force 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). Other workflows are covered in detail in the [Github documentation](https://docs.github.com/get-started/quickstart/fork-a-repo).