Release Review: NetworkSliceBooking r2.3 (public Spring26)#133
Conversation
CAMARA Validation — PASS0 errors, 0 warnings, 14 hints | Profile: standard |
Complete CHANGELOG for r2.3 release
There was a problem hiding this comment.
Hi team, looks great !
/LGTM from Release Management.
2 points for after this release:
-
you need to update the API Description per #131. In addition, the description does not seem to refer to the new API functionality to assign devices. This should be added for completeness.
-
use of external references: you have only used this feature partially. As it does not impact the final published API version (as far as I could see) the current release is approved.
However, I will open an issue to fix this in the next release as it will guarantee consistency with the CAMARA common components (schemas, headers, parameters). See #136.
hdamker
left a comment
There was a problem hiding this comment.
Please update the r2.3 release notes to list all changes since the last public release (r1.2)
r2.3 is a public release. The rule at the top of the changelog says that a public release must list all changes since the previous public release. The previous public release is r1.2 (network-slice-booking v0.1.0).
The current network-slice-booking 0.2.0 section is missing three changes. They were already written in the r2.1 and r2.2 release notes, but they are not in the r2.3 section:
- #87 — the term "session" was renamed to "slice"
- #92 — the
422 SERVICE_NOT_APPLICABLEerror was split intoSERVICE_AREA_NOT_SUPPORTEDandRESOURCES_INSUFFICIENT - #108 — the callback body schema was changed from
CloudEventtoApiNotificationEvent, andmaxLengthwas added
All three are real changes in the 0.2.0 file. #92 and #108 also change the behaviour in a way that is not backward compatible with v0.1.0, so consumers need to see them.
What to do (you can fix this on this PR branch — no need to discard the snapshot):
- Open
CHANGELOG/CHANGELOG-r2.md. - In the
network-slice-booking 0.2.0section, add the missing entries (#87, #92, #108). You can copy the wording from the r2.1 and r2.2 sections. - Keep the existing entries (#116, #120, #130).
- Commit to this branch. The
Full Changelog: ...compare/r1.2...r2.3link is already correct, so no change is needed there.
Optional: the network-slice-assignment 0.1.0 section is the first public version of that API, so it is enough to say it is the initial public definition (from #87 and #96) instead of listing only the latest changes.
Add missing changelog entries for r2.3 release
|
Thanks @hdamker @tanjadegroot , the changelog has updated, please have another review. BTW, the API description for network-slice-assignment is in https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/535625738/NetworkSliceAssignment+API+description. Do you mean that we need merge it into network-slice-booking description? |
No, no need to merge. Thank you for pointing to that description. I had missed the additional API_description. My bad. |
hdamker
left a comment
There was a problem hiding this comment.
Suggestion (not blocking): simplify the network-slice-assignment 0.1.0 release notes
This is the first public release of network-slice-assignment (0.1.0). There is no earlier public version, so the reader has nothing to compare against. The Changed and Removed entries describe edits made while the API was still in development (before any public release), which is not useful for a consumer reading the release notes.
For a first public release it is enough to keep one Added section that lists the main features of the new API. See my suggestion as an example. You can adjust the wording of the feature list. The point is to keep only Added with the main features, and to remove the Changed and Removed sections for this first release.
As said, this comment is non-blocking.
@XunliYang My requested changes on NSB are resolved. For NSA there isn't a previous public version to compare to. Therefore it would be enough to just state which feature were added with it, see my suggestion above. But also fine if you want to keep the changelog entry as is now, just say that you want to keep it and I can approved to unblock the PR. |
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
|
@chinaunicomyangfan All done here now 🎉 ... you can merge the PR, and if the draft release is created automatically, publish it via comment command in the Release Issue #129. |
cebed0f
into
release-snapshot/r2.3-e64cf3d
Release Review: r2.3 public
This PR finalizes the reviewable release content for the active snapshot.
Edit and review this PR before merging it into the release snapshot. After Codeowner and Release Management approval, merging this PR creates the draft release.
Release contents
0.2.00.1.0Dependencies: Commonalities r4.3, ICM r4.2
Codeowner Actions
1. Update release notes
Do not copy administrative, tooling-only, or internal maintenance changes unless they affect API consumers.
2. Confirm API release readiness
release-plan.yamlRelease Management Actions
Required release assets per API status
public
public
M = Mandatory, O = Optional — Full documentation
During the automation introduction phase, please also verify the snapshot content: that
release-metadata.yamlis correct, that the generated API version numbers and server URLs (and other version fields and references) are right, and that the README update reflects the release tag and version handling.Valid next actions for codeowners
/discard-snapshot <reason>in the Release Issue to discard this snapshot, return toplanned, and update content onmainSnapshot:
r2.3-e64cf3d