From 145ad96b08aba0aa8c59dd8db44690fb8b6dd9fa Mon Sep 17 00:00:00 2001 From: Klaus Aehlig Date: Tue, 14 Nov 2023 17:18:52 +0100 Subject: Update Changelog ... clarifying the effect of the target-cache-key change. In particular, explain that, as the cache-key format has changed in a non-overlapping way, no care has to be taken on update, but old target-cache entries will not be used by the newer version of the tool. While there, fix some typos and properly break lines. --- CHANGELOG.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8559f2ca..4af89f8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,17 +27,25 @@ A feature release on top of `1.2.0`, backwards compatible. ### Fixes -- The cache key used for an export target is now based on the export - target itself rather than that of the exported target. The latter - could lead to spourious cache hits, but only in the case where - an explicit file reference was exported and an regular target - with the same name exists. Where the new cache keys overlap with - the old ones, they refer to the same configured targets; so no - special action is to be taken when updating. -- Improved protability and update of the bundled dependencies. +- The cache key used for an export target is now based on the + export target itself rather than that of the exported target. The + latter could lead to spurious cache hits, but only in the case + where the exported target was an explicit file reference, and a + regular target with the same name existed as well. Where the new + cache keys would overlap with the old ones, they would refer to + the same configured targets. However, we used the fact that we + changed the target cache key to also clean up the serialization + format to only contain the JSON object describing repository, + target, and effective configuration, instead of a singleton list + containing this object. Therefore, old and new cache keys do not + overlap at all. In particular, no special care has to be taken + on upgrading or downgrading. However, old target-level cache + entries will not be used leading potentially to rebuilding of + some targets. +- Improved portability and update of the bundled dependencies. - Various minor improvements and typo fixes in the documentation. -- Fixed a race condition in an internal cache of `just execute` used for keeping - track of running operations. +- Fixed a race condition in an internal cache of `just execute` + used for keeping track of running operations. ## Release `1.2.0` (2023-08-25) -- cgit v1.2.3