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

DBW and packages note ready

Browse source
This commit is contained in:
Robert Lanzafame 2025-04-04 16:49:13 +02:00 • committed by GitHub
parent 374bd794d2
commit a6045e7d1e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
book/features/overview.md
View file

@ -66,7 +66,7 @@ A list of tools and features that are dependent on, or related to, the Deploy Bo
Important for these features:
- [](../external/deploy-book-workflow/README.md): the main DBW page
- [](../external/template/README.md): books created from Template include DBW by default
- [](../external/template/README.md): books created from the Template include DBW by default
- [](./draft-release.md): can be configured directly using the DBW
- [](./update_env.md): behaviors of this tool may influence the DBW
- {ref}`TeachBooks Python Package <teachbooks_package>`: included by default in the DBW
@ -75,4 +75,6 @@ Important for these features:
### Environmnets and Caching
_Work in progress._
As described on the [DBW page](../external/deploy-book-workflow/README.md), there is a lot going on "under the hood" with regards to caching of GitHub Action artifacts. This can lead to undesired behavior when using the DBW, especially if package version numbers are not precisely defined. As this would mostly occur when multiple branches are being actively used (new commits on each branch at least once per week), and a package from the `requirements.txt` file is updated in the time between creation of two or more branches, which _also_ has a significant impact on the book building process...we except this to have a relatively low risk of occurring.
Note that Specifying package version numbers explicitly and updating them via [Dependabot](./update_env.md) is an excellent way to ensure that environments in the DBW are always up to date and this issue is avoided.