silva
/
new_site
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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:
George 2023-03-18 18:55:21 -03:00 committed by GitHub
parent 59308f4e82
commit f4a369b559
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -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://noman-bashir.github.io/" target="_blank">★</a>
<a href="https://djherron.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://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://george-gca.github.io/" target="_blank">★</a>
<a href="https://bashirkazimi.github.io/" target="_blank">★</a> <a href="https://bashirkazimi.github.io/" target="_blank">★</a>
</td> </td>
@ -317,13 +317,40 @@ In its default configuration, al-folio will copy the top-level `README.md` to th
#### Upgrading from a previous version #### 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 ```bash
# Assuming the current directory is <your-repo-name> # Assuming the current directory is <your-repo-name>
$ git remote add upstream https://github.com/alshedivat/al-folio.git $ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream $ 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. If you have extensively customized a previous version, it might be trickier to upgrade.