2024-05-14 Release WG Minutes

AGENDA DRAFT

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 Jan Friman Uwe Rauschenbach Murat Karabulut 

Agenda

• 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 doc 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

1. #25 Create a CHANGELOG_TEMPLATE.md within ReleaseManagement/documentation & update it according to API Release Process
2. #xx Update/replacement of Camara_Versioning_Guidelines.md (normative document about API Release process and API Versioning)
3. #28 (in RM): Create updated the API-Readiness-Checklist.md in RM/documentation: Add new API readiness checklist (#28)
4. #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 

Action items

• Update links on CAMARA Project Home wiki page (closed as duplicate)
• Update README.md within RM repository (see https://github.com/camaraproject/ReleaseManagement/issues/20)
• Add issue to Commonalities to move the Change log template up one level Herbert Damker (done in ReleaseManagement repo instead of Commonalities)
• Propose links for RM on the CAMARA Home Page Tanja de Groot
• Transfer issue #7 on API families to Governance Herbert Damker (done: https://github.com/camaraproject/Governance/issues/135)
• Transfer issue #17 on basepath back to Commonalities Herbert Damker (done: https://github.com/camaraproject/Commonalities/issues/199)
• Issue #17: Rafal Artych to apply the update of API guidelines and the common yaml file with the info in issue #17. 
• Issue #10: Tanja de Groot to create short info on API versioning and release process for inclusion in the Commonalities an RM GitHub projects referencing the RM Wiki pages for detailed explanation to reduce overlap.
• Transfer issue #6 on test automation to Commonalities Herbert Damker as this is not part of RM process. (done: https://github.com/camaraproject/Commonalities/issues/200) 
• Transfer issue #11 on mandatory endpoint to Governance Herbert Damker for discussion on how to handle this point.
• issue #12: Close issue. Tanja de Groot (done).
• Issue #5: check example on stable API version in RM pages and add if needed. Tanja de Groot 
• Issue #13: to be closed Tanja de Groot (done)
• Issue #14: mark as backlog Tanja de Groot (done)
• Issue #16: Updated API readiness checklist PR to RM project to be created Tanja de Groot (done: https://github.com/camaraproject/ReleaseManagement/issues/28)
• Issue #16: Create PR in Commonalities to deprecate the Checklist and point to new version in RM. Tanja de Groot (done: https://github.com/camaraproject/Commonalities/issues/202)
• Issue #15: check and add proposal into issue Tanja de Groot (done)
• Issue #15: Transfer back to Commonalities Herbert Damker (done: https://github.com/camaraproject/Commonalities/issues/201)
• Add a FAQ page to the RM wiki with examples. etc Tanja de Groot (done: Release Management FAQ)
• Check for a drawing tool (like draw.io) plugin to be integrated into Confluence Casey Cain