admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: multiple branches

Browse source
This commit is contained in:
Severin 2024-03-03 14:01:23 +01:00
parent 409750bb36
commit 5bb17fd0c5
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -6,9 +6,14 @@ This is the template book. You can fork this to create a book in as easy-as-poss
1. Click `Fork`, and set a name for your new book. 1. Click `Fork`, and set a name for your new book.
2. To enable deploying via GitHub Actions, go to `⚙ Settings`, then to `Pages`, and under `Build and Deployment` set `Source` to `GitHub Actions`. 2. To enable deploying via GitHub Actions, go to `⚙ Settings`, then to `Pages`, and under `Build and Deployment` set `Source` to `GitHub Actions`.
3. To trigger a deployment for the first time, you can go to `Actions` (top panel), then click `deploy-book` on the left, then `Run workflow` on the right. The book is also automatically deployed whenever commits are pushed onto the `main` branch of the repository (in absence of errors). 3. To trigger a deployment for the first time, you can go to `Actions` (top panel), then click `deploy-book` on the left, then `Run workflow` on the right. The book is also automatically deployed whenever commits are pushed (in absence of errors).
Voila! You can now access the copy of the template at Voila! You can now access the copy of the template at
`https://<username>.github.io/<bookname>` (e.g. https://teachbooks.github.io/template). `https://<username>.github.io/<bookname>/` (e.g. https://teachbooks.github.io/template).
It is possible to have multiple versions of a book published at once, by creating another Git branch (e.g. `draft` or `dev`).
For each branch, the respective book is published at `https://<username>.github.io/<bookname>/<branchname>`.
Technical note: for convenience, just `https://<username>.github.io/<bookname>/` redirects to `https://<username>.github.io/<bookname>/book/`, which is itself an alias (a symlink) to
`https://<username>.github.io/<bookname>/main/`.
To learn more about how we do this, please see the [GitHub Actions documentation](https://docs.github.com/en/actions) and our deployment pipeline configuration file `.github/workflows/deploy-book-ghpages.yml`. To learn more about how we do this, please see the [GitHub Actions documentation](https://docs.github.com/en/actions) and our deployment pipeline configuration file `.github/workflows/deploy-book-ghpages.yml`.