Versions Compared

Key

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

...

  • A public-release API version (x.y.z with x>0) is a major/minor/patch stable version of an API.
  • A public-release API version is published as part of a CAMARA meta-release.
  • A public-release API version provides the relevant public items of the release checklist and meets the acceptance criteria of a meta-release checklist.
  • A next public-release API version is introduced if there are updates to the API definition (major/minor/patch).
  • The update of a public-release API version needs to be carefully announced and discussed with API consumers.
  • A public-release API version is part of a CAMARA meta-release

work in progress API version

  • A work in progress API version, with "wip" instead of x.y.z, may exist for an API during the time that one or more PRs are

...

  • committed into the branch of a given API version

...

  • .
  • Between different PR commits, the API version remains "wip".
  • After or with the last PR commit, the next API version is prepared.
  • The maintainers of the API decide on the next API version and the corresponding tag is put on the result of the merge.

pre-release

The term pre-release can be used to refer to an alpha API version or a release-candidate API version.

NOTE: all

pre-release

A pre-release refers to a release-candidate API version apiname-x.y.z-rc.m.

A pre-release has an associated GitHub release package with a "pre-release" tag.

public-release

A public-release API version is an API version meeting all checklist requirements such that it can be published as part of a meta-release.

NOTE: all CAMARA development and pre-release API versions are also publicly available and can be used, but changes may happen to such API versions without notice.

release

An API The term release can be used to refer to either a pre-release -candidate or a public-release version of an API.

...

All API versions of a given meta-release shall be using aligned to the Commonalities and Identity and Consent Management releases that are part of that same meta-release.

...