- Guidelines and assets for Release Management in CAMARA
- Describe, develop, document and apply the deliverables
- Started: November 2023
Release Management
Scope
Release Process Information
The Release Management documents describes the processes and the repository provides the artifacts for use by API Sub projects to release an API version.
It contains the Release Management released documents and assests in the documentation folder:
- API_Release_Guidelines.md – An extract of the API release management process from the CAMARA wiki.
- API-Readiness-Checklist.md – The checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public).
- CHANGELOG_TEMPLATE.md – The template for creating CHANGELOG history of an API repository.
It also contains the following in the documentation/SupportingDocuments folder:
- CHANGELOG_EXAMPLE.md – Pointers to example CHANGELOG.md files over multiple releases created following the release management guidelines.
For the reference documentation on API versioning, please see Chapter 5 in the API Design Guidelines document in Commonalities.
The CHANGELOG.md file describes the differences between releases of the Release Management repository.
Release Management Wiki
Beyond the above reference release management information in GitHub, more information on the release process is available on the wiki.
-
Meta-releases of CAMARA
-
API release management
More information about processes and release numbering for Commonalities and ICM can be found here:
Contributing
- Meetings are held virtually
- Schedule: Weekly on Tuesday’s at 08:00 PT / 16:00 UTC / 17:00 CET
- Meeting link: Meeting Registration / Join
- Meeting minutes are available within the wiki of the Release Management Working Group
- Mailing List
- Subscribe / Unsubscribe to the mailing list of this Working Group https://lists.camaraproject.org/g/wg-release-management.
- A message to all Contributors of this Working Group can be sent using wg-release-management@lists.camaraproject.org.
GitHub respository
- View the GitHub repository for this Sub Project here: https://github.com/camaraproject/ReleaseManagement