2024-05-14 Release WG Minutes
- Herbert Damker
- Tanja de Groot
Attendees & Representation
Type @ and your name to indicate your attendance
LF Staff: @Casey Cain
Community: @Herbert Damker @Tanja de Groot @Rafal Artych @Jose Luis Urien Pinedo @Jan Friman @Uwe Rauschenbach @G. Murat Karabulut
Agenda
The project's Antitrust Policy, which you can find linked from the LF and project websites. The policy is important where multiple companies, including potential industry competitors, are participating in meetings. Please review and if you have any questions, please contact your company legal counsel. Members of the LF may contact Andrew Updegrove at the firm Gesmer Updegrove LLP, which provides legal counsel to the LF. |
Roll Call
Action Items Review
Agenda Bashing
General Topics
Comments from @Herbert Damker regarding 0.x alpha and rc versions in API versioning
Review existing issues in https://github.com/camaraproject/ReleaseManagement/issues
New issue to create/update documentation
New visual for release cycle & milestones
Any Other Topics
Minutes
Action Item Review
Topic 1: 0.x alpha and rc versions in API versioning
Proposed updates will be integrated into the API versioning page
See also below issue #10 on reducing overlap and simplify the API versioning and Release mgmt related documentation In Commonalities
Topic 2: Review existing issues
NOTE: Items in bold are the ones where Commonalities expects results within Commonalities release 0.4.0 scope.
#7 Proposal to establish API Families as Working Groups across API Sub Projects
Labeled as backlog item, transfer issue to Governance @Herbert Damker
#17 Remove basePath in servers.url as variable
Proposal to transfer back to Commonalities,
Expected action: update of Design Guidelines as described in comment by Tanja
#9 Consolidation Issue for open points release management
Need status update after the other issues are addressed
Comments to be reviewed to see if they are all addressed
.#10 Development and Release Branches
Done after update/replacement of Camara_Versioning_Guidelines.md with RM results
Add a FAQ page to the RM wiki with examples. etc
Put normative versioning guidelines in the API design guidelines (yaml focused) (through PR) and link to the explanation in the RM wiki
Merge above Camara_Versioning_Guidelines.md file content into RM wiki page
Add RM guideline short version in RM GitHub project
#6 Automate API design tests to ensure CAMARA compliance
Transfer back to Commonalities and let them close it (linting & testing guidelines are worked on there)
#11 Define mandatory end points URL in each project
Need a guideline to define "atomic APIs" which have to be implemented completely
Open point: Where will implementation guidelines be defined?
Proposed to transfer to Governance
#12 How to manage version for a API family release
Done with defined API Release Process
Add to FAQ when needed
#5 Process to publish v1.0 of an API
Addressed with criteria for Stable API versions
Add explanation to Wiki
#4 Define Release Management for CAMARA
Will be closed. Way of working with OGW Product team is addressed in APIBacklog WG
#13 Consider including Alpha and Beta labels to API versions
Fully addressed. No beta (similar concept are the Initial API versions). To be closed.
#14 API Versioning - Aggregation
backlog item
#16 Readiness Checklist step 6 update proposal
Should be updated and moved to RM GitHub project
New markdown file of checklist will be proposed in an Issue and PR tomorrow by @Tanja de Groot
Create PR in Commonalities to deprecate the Checklist and point to new version in RM @Rafal Artych
Need also to update links to point to the new one
#15 Add guidance for Info object in apis
proposal answer in RM page to be copied into issue and issue to be transferred back to commonalities
Topic 3: New issue to create/update documentation
#xx Update/replacement of Camara_Versioning_Guidelines.md (normative document about API Release process and API Versioning)
#28 (in RM): Create updated the API-Readiness-Checklist.md in RM/documentation: Add new API readiness checklist (#28)
#202 (in Commonalities): Deprecate API-Readiness-Checklist.md (#202)
Topic 4: New visual for release cycle & milestones
New visual using the Confluence macro "Roadmap Planner" is NOK - dates cannot be displayed well.
Ideally draw.io should be integrated into Confluence.
To be checked if that (or some other drawing tool) is an option @Casey Cain