Add API-Readiness-Checklist.md to RM project #29
Conversation
This file replaces the file in Commonalities and is updated as defined in the API release process in the Release Management Wiki Wiki (see https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist)
Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>
Taking into account Herbert's review comments
Updates following Herbert's comments
added column centering and api-version that got lost in translation
There was a problem hiding this comment.
LGTM - Thanks @tanjadegroot. For me it shows what we have agreed within the Release Management working group.
As this Checklist is very important for all Sub Projects I will ask today in the TSC meeting to review the PR and the linked document. So would be good to keep the PR open for about a week.
Note: comments on the document in wiki should be added there.
|
Hi Ludovic,
Yes I add such an explanation
Cheers
Tanja
From: Ludovic Robert ***@***.***>
Sent: Thursday, May 16, 2024 12:51 PM
To: camaraproject/ReleaseManagement ***@***.***>
Cc: Tanja De Groot (Nokia) ***@***.***>; Mention ***@***.***>
Subject: Re: [camaraproject/ReleaseManagement] Add API-Readiness-Checklist.md to RM project (PR #29)
@bigludo7 approved this pull request.
Not a blocker, but, as we can understood the 4 columns as 4 steps should we add a note explaining that it is 'normal' to have initial public-release with same value than release candidate?
—
Reply to this email directly, view it on GitHub<#29 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AU6LGA3JZ6GCC4SEI5SWTULZCSFSBAVCNFSM6AAAAABHYCKH4KVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDANRQGM4DGNBSGQ>.
You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>
|
Added explanation following Ludovic's review comment
| | 9 | Test result statement | O | O | O | M | | | | ||
| | 10 | API release numbering convention applied | M | M | M | M | | | | ||
| | 11 | Change log updated | M | M | M | M | | | | ||
| | 12 | Previous public-release was certified | O | O | O | M | | | |
There was a problem hiding this comment.
If enhanced test plan is not required for the initial public release, and certification of the initial public release is required to have a stable public-release, this is assuming that the test plan used for the first certification is just the basic one, not the enhanced one, is this right? Or is that the initial public release has to be certified once the complete test plan is available.
Added links in Comments column following comment from Fabrizio
Hi @FabrizioMoggio yes, in the comment column you can put what you want including link. I will add that in the documentation of the table, and have put suggestions where people could at a link |
@tanjadegroot I think Fabrizio wanted to add links to guidelines/templates of specific assets, but providing the links to artifacts related to given API version is good idea for me. |
The link is already there in the last line of the file. I changed the text and the name of the link to be more explicit. |
clarified documentation link
|
@soadeyemo Hi Samuel, can you please review and approve the PR ? |
updated text on Status and Comments column
fix typos
|
@soadeyemo - Hi Samuel, sorry, but can you review and approve again please, I fixed some typos and explanations in the checklist. |
What type of PR is this?
What this PR does / why we need it:
This file replaces the file in Commonalities and is updated as defined in the API release process in the Release Management Wiki Wiki (see https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist).
Which issue(s) this PR fixes:
Fixes #28
Special notes for reviewers:
Changelog input
Additional documentation