From 3554f36185d4ce507fbc76d7a694849ae717d1a8 Mon Sep 17 00:00:00 2001 From: Benjamin Schubert Date: Fri, 10 Jan 2020 15:33:53 +0000 Subject: NEWS: Add news information about Consistency breakage --- NEWS | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'NEWS') diff --git a/NEWS b/NEWS index 293085cfe..a4002ff50 100644 --- a/NEWS +++ b/NEWS @@ -20,6 +20,27 @@ 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. + Miscellaneous ------------- -- cgit v1.2.1