Release Management

Repository to describe, develop, document and test the Release Management process.

Scope

• Guidelines and assets for Release Management in CAMARA
• Describe, develop, document and apply the deliverables
• Started: November 2023

Release Process Information

The first public release of the Release Management documents with version v0.2.0 is availalbe in r1.2

It describes the processes and artifacts for use in the Release Management of the Fall24 meta-release.

It contains the Release Management approved documents 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 release type (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 - An example of the content of a CHANGELOG.md over multiple releases created following the Release Management guidelines.

For the reference documentation on API versioning please see Chapter 5 within the API Design Guidelines document in Commonalities.

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

  • Meta-release Plans
  • Meta-release Process

• API release management

  • API Release Process
  • API Release Tracking Process
  • More on API Readiness Checklist
  • More on API Versioning

More information about processes and release numbering for Commonalities and ICM can be found here:

• Commonalities and ICM Release Process

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.