From 582aa690b1d40adbce1d775181789c18f437f7bb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 2 Nov 2025 07:35:09 +0000 Subject: [PATCH 1/4] Bump book/external/deploy-book-workflow from `65010c7` to `6801dcf` Bumps [book/external/deploy-book-workflow](https://github.com/TeachBooks/deploy-book-workflow) from `65010c7` to `6801dcf`. - [Release notes](https://github.com/TeachBooks/deploy-book-workflow/releases) - [Commits](https://github.com/TeachBooks/deploy-book-workflow/compare/65010c7dc0eff87eb4d7729ee251d0df221c44f8...6801dcfaedd1baf88ab51ebe360241e4eaf39ed2) --- updated-dependencies: - dependency-name: book/external/deploy-book-workflow dependency-version: 6801dcfaedd1baf88ab51ebe360241e4eaf39ed2 dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- book/external/deploy-book-workflow | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 65010c7..6801dcf 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 65010c7dc0eff87eb4d7729ee251d0df221c44f8 +Subproject commit 6801dcfaedd1baf88ab51ebe360241e4eaf39ed2 From beeb6f775ec2eb02467bdfcc8b504e473d9fbabe Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 2 Nov 2025 07:35:17 +0000 Subject: [PATCH 2/4] Bump book/external/template from `5183c16` to `6401393` Bumps [book/external/template](https://github.com/TeachBooks/template) from `5183c16` to `6401393`. - [Commits](https://github.com/TeachBooks/template/compare/5183c1616932c85a398e561124cf046288695101...6401393f8d50cc66ecba1e923cdbb221b7db0b3e) --- updated-dependencies: - dependency-name: book/external/template dependency-version: 6401393f8d50cc66ecba1e923cdbb221b7db0b3e dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- book/external/template | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/template b/book/external/template index 5183c16..6401393 160000 --- a/book/external/template +++ b/book/external/template @@ -1 +1 @@ -Subproject commit 5183c1616932c85a398e561124cf046288695101 +Subproject commit 6401393f8d50cc66ecba1e923cdbb221b7db0b3e From a78f2f0af5006bd303205bc6948da61f85395614 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 2 Nov 2025 08:56:36 +0100 Subject: [PATCH 3/4] Update documentation for publishing book versions --- book/features/release_book_online.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/features/release_book_online.md b/book/features/release_book_online.md index 98df709..3ae47b8 100644 --- a/book/features/release_book_online.md +++ b/book/features/release_book_online.md @@ -18,7 +18,7 @@ This section is useful for user type 3-5. [{octicon}`mark-github` Repository deploy book workflow](https://github.com/TeachBooks/deploy-book-workflow) -[{octicon}`book` Documentation](../installation-and-setup/versions_URLs.md) +[{octicon}`book` Publish version on separate (fixed) URLs](../installation-and-setup/versions_URLs.md) {octicon}`pencil` Exercises: - [Your version of the book](https://teachbooks.io/template/exercises/004.html) @@ -254,4 +254,4 @@ Unlike the virtual environments (next subsection), caches of the book build do n ### Effect of Caching on Virtual Environment -In particular, note that older branches may have been built with cached environments that are different than those in a newer branch, leading to (undesired) differences in book appearance or functionality---often without the author being aware! This occurs if a package in `requirements.txt` is updated in the time between the creation of environments on different branches, as `pip` will use the newest version when downloading a package (the first time a venv cache is created in the DBW), but it will not always automatically update a package if `pip install -r requirements.txt` is used on an existing environment (this happens every time an existing cache is used!). This means that, when compared to the venv on a newer branch, a frequently used branch (where the cache has not expired) may retain old and out of date packages long after an updated version is available; however, since the week number is included in the venv file hash, this will last for a maximum of 1 week. A best practice to avoid this situation is to pin version numbers explicitly (e.g., `teachbooks==0.2.0`) if you want book builds to remain consistent. In addition, a feature like dependabot can be used to automatically notify you when an update is made; this is [here](./update_env.md). \ No newline at end of file +In particular, note that older branches may have been built with cached environments that are different than those in a newer branch, leading to (undesired) differences in book appearance or functionality---often without the author being aware! This occurs if a package in `requirements.txt` is updated in the time between the creation of environments on different branches, as `pip` will use the newest version when downloading a package (the first time a venv cache is created in the DBW), but it will not always automatically update a package if `pip install -r requirements.txt` is used on an existing environment (this happens every time an existing cache is used!). This means that, when compared to the venv on a newer branch, a frequently used branch (where the cache has not expired) may retain old and out of date packages long after an updated version is available; however, since the week number is included in the venv file hash, this will last for a maximum of 1 week. A best practice to avoid this situation is to pin version numbers explicitly (e.g., `teachbooks==0.2.0`) if you want book builds to remain consistent. In addition, a feature like dependabot can be used to automatically notify you when an update is made; this is [here](./update_env.md). From 5126a57e676876f8526f1c295f2360f92f685c18 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 2 Nov 2025 08:57:51 +0100 Subject: [PATCH 4/4] Update documentation for collaborative book editing --- book/features/write_online.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/features/write_online.md b/book/features/write_online.md index f0d0a02..40fa9be 100644 --- a/book/features/write_online.md +++ b/book/features/write_online.md @@ -18,7 +18,7 @@ This section is useful for user type 3-5. [{octicon}`mark-github` Repository template](https://github.com/TeachBooks/template) -[{octicon}`book` Documentation](../workflows/collaboration.md) +[{octicon}`book` Collaborative book-editing](../workflows/collaboration.md) {octicon}`pencil` Exercises: - [First file edit](https://teachbooks.io/template/exercises/001.html)