Skip to content

Commit 6fd714c

Browse files
authored
README upgrade (#1394)
1 parent 1c0560f commit 6fd714c

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0
266266
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.
267267
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).
268268

269+
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.
269270

270271
<details><summary>(click to expand) <strong>Manual deployment to GitHub Pages:</strong></summary>
271272

@@ -326,7 +327,11 @@ In its default configuration, al-folio will copy the top-level `README.md` to th
326327

327328
#### Upgrading from a previous version
328329

329-
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:
330+
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.
331+
332+
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.
333+
334+
Then go to Actions -> New workflow -> set up a workflow yourself, setup the following workflow and commit your changes:
330335

331336
```yaml
332337
name: Sync from template

0 commit comments

Comments
 (0)