You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@
5
5
This page is useful for user type 3, 4 and 5.
6
6
```
7
7
8
-
We developed a workflow which builds the Jupyter Books in your repository for all branches, and publishes them online via GitHub Pages.
8
+
We developed a workflow which builds the TeachBooks in your repository for all branches, and publishes them online via GitHub Pages.
9
9
10
10
It has the following features:
11
-
- Publishing of your [Jupyter Book](https://github.com/executablebooks/jupyter-book)-repository to GitHub Pages
12
-
- Publishes both private (GitHub Pro, GitHub Team, GitHub Enterprise Cloud, or GitHub Enterprise Server required) and public (GitHub Free is enough) repositories. GitHub Teams is free for teacher as described in the [GitHub documentation](https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers#github-education-features-for-teachers). If you’ve a organization for your book on GitHub, link your GitHub team rights to your organization as described on the [GitHub website](https://github.com/team#organizations).
13
-
- Publishing all or a selection of branches, allowing to build draft version of the book online preventing local builds
14
-
- A summary describing where the book is published, errors in the build process per branch and how the publish step is configured
11
+
- Publishing of your [TeachBook](https://teachbooks.tudelft.nl/)-repository (built with [Jupyter Book](https://github.com/executablebooks/jupyter-book)) to GitHub Pages
12
+
- Publishes both private (GitHub Pro, GitHub Team, GitHub Enterprise Cloud, or GitHub Enterprise Server required) and public (GitHub Free is enough) repositories. GitHub Teams is free for teacher as described in the [GitHub documentation](https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers#github-education-features-for-teachers). If you’ve a organization for your TeachBook on GitHub, link your GitHub team rights to your organization as described on the [GitHub website](https://github.com/team#organizations).
13
+
- Publishing all or a selection of branches, allowing to build draft version of the TeachBook online preventing local builds
14
+
- A summary describing where the TeachBook is published, errors in the build process per branch and how the publish step is configured
15
15
- Caching of build books so that it can be reused when another branch is published or the next build contains critical errors
16
16
- Caching of python environment to speed up the workflow
17
17
- Allowing to use submodules within your book
@@ -27,15 +27,15 @@ The [TeachBooks template book](https://github.com/TeachBooks/template) uses this
27
27
## How to start using this workflow
28
28
This workflow is used in `TeachBooks/template`. Feel free to use it for your TeachBook as well:
29
29
1. Add [`teachbooks`](https://github.com/TeachBooks/TeachBooks) to your `requirements.txt` file in your root folder
30
-
2. Move all the book files (including `_config.yml` and `_toc.yml`) to a subdirectory `book/`.
30
+
2. Move all the TeachBook files (including `_config.yml` and `_toc.yml`) to a subdirectory `book/`.
31
31
3. Copy the [`call-deploy-book.yml` workflow](https://github.com/TeachBooks/deploy-book-workflow/blob/main/.github/workflows/call-deploy-book.yml) to the `/.github/workflows` folder in your repository.
You can adapt the behaviour by setting repository variables as explained [here](https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository) or using the [VS Code Extension GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions). Define the following repository variables:
41
41
-`PRIMARY_BRANCH` which is set to `main` whenever it's not defined in the repository variables.
0 commit comments