admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 14:55:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update section on branches

Browse source
This commit is contained in:
Caspar Jungbacker 2023-09-23 13:24:37 +02:00
parent 30c6674024
commit aa7ddeaf8d
1 changed files with 2 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
book/workflows/git-branch.md
View file

@ -50,10 +50,6 @@ The branch selection menu, where our new branch has shown up.
5. Now that we've created and checked out our new branch, we can start {ref}`making and committing changes <stage-commit-push>`.
## Predefined branches
## The `publish` branch
If your repository is located in the [Interactive Textbooks CiTG](https://gitlab.tudelft.nl/interactivetextbooks-citg) group on GitLab, it is likely that it already has some predefined branches in addition to `main`, namely `publish` and `publish-html`. These branches serve the following purposes:
- `main`: this is the main development branch on which new changes are collected. When the work on your own branch is done, you make a merge request to add your changes to `main`. This branch is protected, meaning that all changes to this branch have to be done via merge requests and you cannot push to it directly.
- `publish`: this is the version of the book that is visible to the public (i.e., the version that the students will see). Again, you cannot push directly to this branch.
- `publish-html`: this branch contains the HTML of the version of the book that lives on the `publish` branch. When a new version of the book is merged in the `publish` branch, the new book is built using the `jupyter book build` command and the HTML is uploaded to `publish-html`. The webserver is constantly fetching this branch and pulling any incoming changes.
If your repository is located in the [Interactive Textbooks CiTG](https://gitlab.tudelft.nl/interactivetextbooks-citg) group on GitLab, you will see that it already has a branch called `publish`. This branch is where the student version of your book should go. The idea behind this is that the student version of your book should only change a few times per year at most (and certainly not right before an exam!) to prevent confusion. This way, you can still make frequent changes to the `main` branch.