Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Release Management process is based on API versions and their associated release assets. It uses

  • work-in-progress API version is used during the development of an the API. This versions is not considered as release and is not usable by API consumers.
  • initial or alpha (-initial ((api-0.y.z) or alpha (api-x.y.z-alpha.m) API versions (with version extensions) are used for CAMARA internal API development purposes
  • release-candidate (api-x.y.z-rc.n) API versions (with version extensions) are used for CAMARA internal API release management purposes
  • public-release API versions (api-x.y.z) are used for API versions that are part of a meta-release. These API versions only have API version number x.y.z (semver 2.0), no version extension.
  • work-in-progress API version is used during the development of an the API in between pre-releases. This versions is not considered as a release and is not usable by API consumers.
  • An API version release is identified by putting an API version tag on the main or on a release branch (the latter in case of changes to a public-released API).
  • An API release consists in creating the related set of API version assets and delivering them in an API version release package.
  • Note 1: People are free to use initial, alpha or release-candidate API versions available in the CAMARA GitHub at their own risk.
  • Note 2: API families are not versioned, nor release-managed. Only API versions are release-managed.

The following next sections provide the definitions and the description of the release management processes, and illustrates by examples.

The rest of the text in this section can be removed once the proposal is agreed.

It consolidates inputs from 

...