Skip to content

Commit 2fb29d7

Browse files
committed
Update docs to use MergeFrom-Template.ps1
1 parent d4ce11e commit 2fb29d7

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,17 @@ Configuration is in the `.github/renovate.json` file.
8282
When changing the renovate.json file, follow [these validation steps](https://docs.renovatebot.com/config-validation/).
8383

8484
If Renovate is not creating pull requests when you expect it to, check that the [Renovate GitHub App](https://github.com/apps/renovate) is configured for your account or repo.
85+
86+
## Merging latest from Library.Template
87+
88+
### Maintaining your repo based on this template
89+
90+
The best way to keep your repo in sync with Library.Template's evolving features and best practices is to periodically merge the template into your repo:
91+
`
92+
```ps1
93+
git fetch
94+
git checkout origin/main
95+
.\tools\MergeFrom-Template.ps1
96+
# resolve any conflicts, then commit the merge commit.
97+
git push origin -u HEAD
98+
```

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,13 @@ Further customize your repo by:
4242
### Maintaining your repo based on this template
4343

4444
The best way to keep your repo in sync with this template's evolving features and best practices is to periodically merge the template into your repo:
45-
45+
`
4646
```ps1
47-
git checkout main # your default branch
48-
git pull # make sure you're at tip
49-
git fetch libtemplate # fetch latest Library.Template
50-
git merge libtemplate/main
47+
git fetch
48+
git checkout origin/main
49+
.\tools\MergeFrom-Template.ps1
50+
# resolve any conflicts, then commit the merge commit.
51+
git push origin -u HEAD
5152
```
5253

5354
There will frequently be merge conflicts to work out, but they will be easier to resolve than running the `Apply-Template.ps1` script every time, which simply blows away all your local changes with the latest from the template.

0 commit comments

Comments
 (0)