From 2df1be74cb38758efbd146f2e5fbd378084b9d0a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 22 Apr 2025 15:31:46 +0200 Subject: [PATCH] Update overview.md --- book/features/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/features/overview.md b/book/features/overview.md index 49c62c5..33e603f 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -89,10 +89,10 @@ To use the [Draft-Release Workflow](./draft-release.md) with the Deploy Book Wor teachbooks build --release book/ ``` -### Environmnets and Caching +### Environments and Caching 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. In general we expect the risk of this occurring to be low, as it should only happen when multiple branches are being actively used (new commits on each branch at least once per week), a package from the `requirements.txt` file is updated in the time between creation of two or more branches, and that package _also_ has a significant impact on the book building process. As the Python virtual environment cache is replaced by default if older than one week, the issue should resolve itself within that time frame. 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. -If you are _not_ using Dependabot and are not able to get your packages updated when the DBW is running, delete the cache manually and rerun your GitHub Actions job (go to Actions tab, then looking for the "Caches" section under the "Management" pane on the left hand side of the screen). \ No newline at end of file +If you are _not_ using Dependabot and are not able to get your packages updated when the DBW is running, delete the cache manually and rerun your GitHub Actions job (go to Actions tab, then looking for the "Caches" section under the "Management" pane on the left hand side of the screen).