Release Management Working Group description

Input for the camaraproject.org page.

The Release Management Working Group defines the release processes of the CAMARA project. This covers the releases of Working Group deliverables and the releases of APIs by the API Sub Projects. It also defines the meta-release process that enables managing consistency across APIs.

CAMARA meta-release

A CAMARA meta-release combines a set of CAMARA API versions into a consistent release.

There are two meta-releases per year (in spring and in fall) such that

• API providers can plan their API implementations and deployments in production.

• API consumers can plan the integration in their platform and applications.

All API versions in a meta-release comply with the CAMARA guidelines from Commonalities and Identity and Consent Management (part of that same meta-release), and fulfill defined quality criteria.

CAMARA meta-releases ensure

• Availability of consistent API definitions (by use of guidelines, templates, and linting),

• Quality of API definitions (by use of checklists, test definitions, and release management),

• Stability of API definitions (clear criteria for stable versus initial API versions) and

• Reliability of schedule and deliverables (with defined milestones and release candidates).

CAMARA meta-releases provide the foundation for API version management in production.

API versions and their release

CAMARA follows Semantic Versioning 2.0.0 for API versioning (x.y.z).

CAMARA differentiates between initial API versions (x = 0) and stable API versions (x > 0). There are some CAMARA specific rules for releasing initial API versions.

An API Sub Project may release an initial API version outside of a meta-release (Sandbox APIs only). More mature APIs (Incubating, Graduated) shall release new versions or updates through a meta-release.

-----------------------------------------------------------------------------------------------------------

Working Group Wiki: Release Management Wiki

Working Group Repository: ReleaseManagemen repository

Working Group Deliverable Version(s) and Release Date(s):

• API_Release_Guidelines

• API versioning (in Commonalities API-design-guidelines)

• Artifacts:

  • API-Readiness-Checklist

  • CHANGELOG_TEMPLATE