consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'Keep your fork updated' instructions

Browse Source
This commit is contained in:
taitus
2024-08-12 18:47:19 +02:00
parent e858e226cd
commit 0a83661e95
2 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/en/getting_started/update.md
View File

@@ -27,19 +27,19 @@ git remote -v
again you should get:
> upstream git@github.com:consuldemocracy/consuldemocracy.git (fetch)\
> upstream git@github.com:consuldemocracy/consuldemocracy.git (push)\
> origin git@github.com:your_user_name/consuldemocracy.git (fetch)\
> origin git@github.com:your_user_name/consuldemocracy.git (push)
> origin git@github.com:your_user_name/consuldemocracy.git (push)\
> upstream git@github.com:consuldemocracy/consuldemocracy.git (fetch)\
> upstream git@github.com:consuldemocracy/consuldemocracy.git (push)
## Pulling changes from Consul Democracy
Start by creating a branch named **upstream** from your **master** branch to apply Consul Democracy changes:
Start by creating a branch named **upgrade** from your **master** branch to apply Consul Democracy changes:
```bash
git checkout master
git pull
git checkout -b upstream
git checkout -b upgrade
```
Then we can fetch all changes from the **Consul Democracy** remote server with:
@@ -52,7 +52,7 @@ And then you can choose to either:
A. Get all the latest changes on Consul Democracy's **master** branch with `git merge upstream/master`.
B. Just update up to an specific release tag (so you can do incremental updates if you're more than one release behind). For example to update up to [v0.9](https://github.com/consuldemocracy/consuldemocracy/releases/tag/v0.9) release just: `git merge v0.9`.
B. Just update up to an specific release tag (so you can do incremental updates if you're more than one release behind). For example to update up to [1.3.0](https://github.com/consuldemocracy/consuldemocracy/releases/tag/1.3.0) release just: `git merge 1.3.0`.
## Merging changes
@@ -60,10 +60,10 @@ After the previous section `merge` command, there are three possible outcomes:
A. You get a nice `Already up-to-date.` response. That means your fork is up to date with Consul Democracy 😊👌.
B. You get a screen on your git configured editor showing the commit message `Merge remote-tracking branch 'upstream/master' into upstream`. That means git was able to grab latest changes from Consul Democracy's master branch, and it can merge them without code change conflicts. Finish the commit.
B. You get a screen on your git configured editor showing the commit message `Merge remote-tracking branch 'upstream/master' into upgrade`. That means git was able to grab latest changes from Consul Democracy's master branch, and it can merge them without code change conflicts. Finish the commit.
C. You get some git errors along with a `Automatic merge failed; fix conflicts and then commit the result.` message. That means there are conflicts between the code changes you did and the ones done on Consul Democracy repository since the last time you update it. That's the main reason we strongly recommend often updates of your fork (think at least monthly). Resolve merge conflicts carefully and commit them.
Now you can just simply push your **upstream** branch to github and create a Pull Request so you can easily check all changes going into your repo, and see your tests suite runs.
Now you can just simply push your **upgrade** branch to github and create a Pull Request so you can easily check all changes going into your repo, and see your tests suite runs.
Remember you can always quickly check changes that will come from Consul Democracy to your fork by replacing **your_org_name** on the url: <https://github.com/your_org_name/consuldemocracy/compare/master...consuldemocracy:master>.