README upgrade (#1394)

This commit is contained in:
Raffaele Mancuso 2023-05-09 16:53:21 +02:00 committed by GitHub
parent 1c0560fc03
commit 6fd714c897
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions

View File

@ -266,6 +266,7 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0
4. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
5. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
If you keep your site on another branch, open `.github/workflows/deploy.yml` **on the branch you keep your website on** and change on->push->branches and on->pull\_request->branches to the branch you keep your website on. This will trigger the action on pulls/pushes on that branch. The action will then deploy the website on the branch it was triggered from.
<details><summary>(click to expand) <strong>Manual deployment to GitHub Pages:</strong></summary>
@ -326,7 +327,11 @@ 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 configure a [GitHub action](https://github.com/AndreasAugustin/actions-template-sync) to automatically sync your repository with the latest version of the theme:
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.
Go to Settings -> Actions -> General -> Workflow permissions, give Read and write permissions to GitHub Actions, check "Allow GitHub Actions to create and approve pull requests", and save your changes.
Then go to Actions -> New workflow -> set up a workflow yourself, setup the following workflow and commit your changes:
```yaml
name: Sync from template