forked from alshedivat/al-folio
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added information about using github action (alshedivat#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](george-gca/george-gca.github.io#13). Signed-off-by: George Araújo <[email protected]>
- Loading branch information
1 parent
18185f3
commit 332bf39
Showing
1 changed file
with
30 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -89,7 +89,7 @@ Feel free to add your own page(s) by sending a PR. | |
<a href="https://noman-bashir.github.io/" target="_blank">★</a> | ||
<a href="https://djherron.github.io/" target="_blank">★</a> | ||
<a href="https://rodosingh.github.io/" target="_blank">★</a> | ||
<a href="https://vdivakar.github.io/" target="_blank">★</a> | ||
<a href="https://vdivakar.github.io/" target="_blank">★</a> | ||
<a href="https://george-gca.github.io/" target="_blank">★</a> | ||
<a href="https://bashirkazimi.github.io/" target="_blank">★</a> | ||
</td> | ||
|
@@ -316,13 +316,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/[email protected] | ||
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. | ||
|