Versions Compared

Key

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

...

Info

Please note that initial public API versions can be

  • released at any time outside the meta-release process in order to allow for rapid API evolution.
  • released as part of a meta-release
    • in this case, the milestones defined for the meta-release have to be followed.
    • it is expected that in the next meta-release this public API version becomes stable.


Meta-release

When planning to deliver a public API version into To be part of a meta-release, the API Sub Project needs to participate in the meta-release process. (Pre-)releases need For the meta-release, the following needs to be provided as follows:

  • the API release tracker (see [API release trackers](https://wiki.camaraproject.org/x/HQBFAQ))
  • the expected (pre-)releases need to be provided at the respective M3 and M4 milestones
  • minimally an initial public release needs to be provided for the meta-release.API version
  • each (pre-)release must include the required set of API release assets according to the API readiness checklist (see below).
  • API (pre-)releases are numbered (tagged) using the API release numbering guideline (see below).

Example of the use of the API release process

...

release typeAPI version

release number (release tag)

release package

release package taglabel
N/Awork-in-progressN/AN/AN/A
pre-releasealpha

rx.1 ... rx.m

optional

optional: "pre-release"
pre-releaserelease-candidate

rx.m+1 ... rx.n

mandatory"pre-release"
releasepublicrx.n+1mandatory"latest"
maintenance releasepublicrx.n+2 ... rx.n+pmandatory"latest"

...