diff options
author | Benjamin Schubert <bschubert15@bloomberg.net> | 2020-01-10 15:33:53 +0000 |
---|---|---|
committer | Benjamin Schubert <bschubert15@bloomberg.net> | 2020-01-16 12:17:29 +0000 |
commit | 503c755c49dcc566b30d4cbdd8610e03be57429a (patch) | |
tree | e27224c7f4a3b45c34689ae863b352c0812fc8ea | |
parent | 9658e2f9398eeb4812f029117b302d11aa33d980 (diff) | |
download | buildstream-bschubert/optimize-consistency-2.tar.gz |
NEWS: Add news information about Consistency breakagebschubert/optimize-consistency-2
-rw-r--r-- | NEWS | 21 |
1 files changed, 21 insertions, 0 deletions
@@ -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 ------------- |