Migrating from Peak SDK 0.0.5 to 0.0.6
Changing release
key format
In version 0.0.6
, we have updated the format of the release
key to provide more flexibility and clarity in specifying the release version. Previously, the release
key was a string value, but it is now an object with a nested version
property.
While creating app or block specs, we used to pass the release info like this:
// Before (Version 0.0.5 and below): "release": { "release": "0.0.1", "notes": "This is an initial version", }, // After (Version 0.0.6) "release": { "version": "0.0.1", "notes": "This is an initial version", },
While defining block spec config, we need to use nested
release
object:// Before (Version 0.0.5 and below): "config": [ { "id": "0bddb4c6-40c5-45c3-b477-fceb2c051609", "release": "1.0.0", }, ], // After (Version 0.0.6) "config": [ { "id": "0bddb4c6-40c5-45c3-b477-fceb2c051609", "release": { "version": "1.0.0", }, }, ],
While describing the release for apps or blocks, we now need to use the
--version
flag instead of--release
to specify the release version.# Before peak apps specs describe-release --spec-id <spec_id> --release 1.0.0 # After peak apps specs describe-release --spec-id <spec_id> --version 1.0.0