Added information about using github action (#1226)
By using this Github action it is possible to keep the derived repository up-to-date with its template. I am currently using this to keep my website up to date with the template repository. An example of the PR this action creates can be seen [here](https://github.com/george-gca/george-gca.github.io/pull/13). Signed-off-by: George Araújo <george.gcac@gmail.com>
This commit is contained in:
parent
59308f4e82
commit
f4a369b559
31
README.md
31
README.md
|
|
@ -317,13 +317,40 @@ In its default configuration, al-folio will copy the top-level `README.md` to th
|
|||
|
||||
#### Upgrading from a previous version
|
||||
|
||||
If you installed **al-folio** as described above, you can upgrade to the latest version as follows:
|
||||
If you installed **al-folio** as described above, you can configure a [github action](https://github.com/AndreasAugustin/actions-template-sync) to automatically sync your repository with the latest version of the theme:
|
||||
|
||||
```yaml
|
||||
name: Sync from template
|
||||
on:
|
||||
# cronjob trigger
|
||||
schedule:
|
||||
- cron: "0 0 1 * *"
|
||||
# manual trigger
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
repo-sync:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# To use this repository's private action, you must check out the repository
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: actions-template-sync
|
||||
uses: AndreasAugustin/actions-template-sync@v0.7.3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
source_repo_path: alshedivat/al-folio
|
||||
upstream_branch: master
|
||||
```
|
||||
|
||||
You will receive a pull request within your repository if there are some changes available in the template.
|
||||
|
||||
Another option is to manually update your code by following the steps below:
|
||||
|
||||
```bash
|
||||
# Assuming the current directory is <your-repo-name>
|
||||
$ git remote add upstream https://github.com/alshedivat/al-folio.git
|
||||
$ git fetch upstream
|
||||
$ git rebase v0.3.5
|
||||
$ git rebase v0.8.0
|
||||
```
|
||||
|
||||
If you have extensively customized a previous version, it might be trickier to upgrade.
|
||||
|
|
|
|||
Loading…
Reference in New Issue