Prepare release r0.6 #151
Prepare release r0.6 #151
Conversation
akoshunyadi
added
the
subproject management
akoshunyadi
requested review from
eric-murray,
bigludo7 and
sachinvodafone
as code owners
There was a problem hiding this comment.
See my comments and suggestions below.
My general question: What is the purpose of this release?
Do you see device-status 0.6.0-alpha.1 on the same level as 0.5.1 as the new latest release?
Then you should potentially think about directly release with API version 0.6.0 under the previous rules and start the new cycle with splitted APIs with a new target version 0.7.0.
Or do you see the device-status 0.6.0-alpha.1 just as a CAMARA internal tag to preserve the current status and to allow some developers to try to implement it? The split of the APIs will still happen have 0.6.0-* versions?
I'm just asking as in QoD we are doing the split after 0.10.1 and before the first (even alpha) version of 0.11.0. But the situation in DeviceStatus is for sure different.
CHANGELOG.md
Outdated
| ## Please note: | ||
| - This is an alpha version, it should be considered as a draft. | ||
| - There are bug fixes to be expected and incompatible changes in upcoming versions. | ||
| - The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. |
There was a problem hiding this comment.
I would delete this line, I wouldn't consider it "suitable for implementations" if it immediately afterwards will be splitted in three APIs ... the sentence fits better for a release candidate version, but not for an alpha.
README.md
Outdated
| @@ -27,11 +27,11 @@ Repository to describe, develop, document and test the DeviceStatus API family | |||
| * Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available public release**. | |||
|
|
|||
| <!-- following part left in for now but could be omitted going forward --> | |||
| * The latest available and released version 0.5.1 of the API is available within the [release-0.5.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.1) | |||
| * The latest available release version 0.6 (with API version 0.6.0-alpha.1) is available within the [release-0.6 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.6) | |||
There was a problem hiding this comment.
r0.6 contains only a pre-release version of the API version 0.6.0, not the latest public-release initial version (which is still 0.5.1).
You can consider the complete part and replace with the following lines:
The latest public release is available here: https://github.com/camaraproject/DeviceStatus/releases/latest
Pre-releases of this sub project are available in https://github.com/camaraproject/DeviceStatus/releases
For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceStatus/blob/main/CHANGELOG.md)
Co-authored-by: Herbert Damker <[email protected]>
Update url with alpha version
|
@hdamker alpha1 it is meant as the latest of your alternatives: an internal version which can be tried by some developer teams to get early feedback to the v0.6.0, which will contain the splitted APIs too. |
What type of PR is this?
What this PR does / why we need it:
Prepare the release version 0.6 with the Device Status API version 0.6.0-alpha.1
Which issue(s) this PR fixes:
Special notes for reviewers:
Requesting for detailed review, since this is the first release following the new releasing guidelines.
Changelog input
Additional documentation