From 2d82d492c7d557b6391f9707339c194c6c39c983 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 16 Apr 2024 22:07:46 +0200 Subject: [PATCH] Update github_deploy.md --- book/features/github_deploy.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/book/features/github_deploy.md b/book/features/github_deploy.md index e839949..8908f66 100644 --- a/book/features/github_deploy.md +++ b/book/features/github_deploy.md @@ -9,6 +9,8 @@ We developed a workflow which builds the Jupyter books in your repository for al To use this feature, add the workflow [`call-deploy-book.yml`](https://github.com/TeachBooks/deploy-book-workflow/blob/main/.github/workflows/call-deploy-book.yml) to the `/.github/workflows` folder in your repository. Furthermore, set source for GitHub pages to GitHub Actions under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`. Additional tip: set repository website as your GitHub Pages website under `Code`- `About` - - `Website` - `Use your GitHub Pages Website` +This workflow requires a `requirements.txt` file with `teachbooks` in your root folder, and all the book files (including `_config.yml` and `_toc.yml`) should be in a subdirectory `book/`. + You can adapt the behaviour by setting repository variables in GitHub as explained [here](https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository). Define the following repository variables: - `PRIMARY_BRANCH` which is set to `main` whenever it's not defined in the repository variables. - This sets the branch which is hosted on root. @@ -28,4 +30,4 @@ Whenever the workflow is triggered, progress can be seen under the `Actions` tab in GitHub. From this tab, you can also initiate it without any trigger commits. -When the workflow has finished, visit your build book at `https://.github.io/` (case sensitive). Eg. for the [template book](https://github.com/TeachBooks/template) it is [https://teachbooks.github.io/template](https://teachbooks.github.io/template). \ No newline at end of file +When the workflow has finished, visit your build book at `https://.github.io/` (case sensitive). Eg. for the [template book](https://github.com/TeachBooks/template) it is [https://teachbooks.github.io/template](https://teachbooks.github.io/template).