summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Schubert <bschubert15@bloomberg.net>2020-01-10 15:33:53 +0000
committerBenjamin Schubert <bschubert15@bloomberg.net>2020-01-15 14:47:32 +0000
commita517dd33ee258ac2c7a6362290b728bc3d2a305e (patch)
tree6b10c72bbc986ed9782d65f6035b5cd09b7f5730
parente2f11fc47407a716a9a54674c6f347369927664d (diff)
downloadbuildstream-bschubert/optimize-consistency-tests.tar.gz
NEWS: Add news information about Consistency breakagebschubert/optimize-consistency-tests
-rw-r--r--NEWS22
1 files changed, 22 insertions, 0 deletions
diff --git a/NEWS b/NEWS
index 602b14b51..0f0fb5621 100644
--- a/NEWS
+++ b/NEWS
@@ -20,6 +20,28 @@ API
Plugins authors that do this and believe BuildStream should be testing that
part of their plugins should open an issue on BuildStream.
+ o BREAKING CHANGE: `Consistency` has been removed and
+ `Source.get_consistency()` has been replaced by `Source.is_resolved()`
+ and `Source.is_cached()`.
+
+ `Source.is_resolved()` has a default of `self.get_ref() is not None`,
+ so if the only thing your plugin requires for being resolved is to
+ have a valid ref, you don't need to do anything there.
+
+ `Source.is_cached()` is there to replace a `Consistency.CACHED`
+ implementation and will need to be implemented by plugin authors.
+
+
+Core
+----
+
+ o BREAKING CHANGE: Once a source has been put in the internal BuildStream
+ cache, its content will not get checked for validity unless a workspace
+ is opened on it. If you see a warning that was not fatal as you fetch
+ your source and want to re-test it to make sure it's gone without changing
+ its ref (most plugins would handle that correctly), you will need to delete
+ the internal source cache first.
+
==================
buildstream 1.91.3