Versions Compared

Key

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

The CAMARA release process requires each API Sub Project to plan and track their API versions so that the meta-release can be planned.

...

Meta-release

The name of the meta-release, e.g. Fall24. Put N/A if the API version is planned to be an initial public version only outside of the meta-release.

API name

The API name. For the definition of "API name" on this page see: API Release Process, e.g. geofencing
GroupThe name of the API Sub project under which the repository of the API is managed, e.g. DeviceLocation 
RepositoryThe shortened link to GitHub repository for the API, e.g. DeviceLocation 
Target versionThe API version that you plan to publish in the meta-release, e.g. 0.5.0, 1.0.0, 1.1.0, etc. Patch versions are 
Maturity levelIndicates the maturity of the public API version that is targeted in the upcoming meta-release: choose one of "initial" or "stable".
Target scopeScopeThe shortened link to a GitHub issue called "Scope for API-name version <x.y.z>" which needs to be created latest at M1 and resolved by M3 e.g. DeviceLocation/issues/58
Readiness checklist

Github file macro
collapsibletrue
urlhttps://github.com/camaraproject/QualityOnDemand/blob/main/documentation/API_documentation/quality-on-demand-API-Readiness-Checklist.md
Edit the macro and put the URL of the API-Readiness-Checklist.md

API version

The version of the latest (pre-)release (alpha, release-candidate or public release) API version. This field is to be updated with each (pre-)release date, e.g. 0.2.0-alpha.3, 0.10.0-rc.2, 0.10.1, 1.0.0-rc.5, etc.)

M3 date

The date of the release PR availability or the date of the release of the API version after approval of its release PR. Update this field with each pre-release created between M1 and M3. The last pre-release date is the M3 date of the API. Format is yyyy-mm-dd.

M3 releaseThe shortened link to the release PR when available for review, and once released, the shortened link to the release tag of the latest pre-release (alpha or release-candidate) for the API version e.g. r1.10. The last pre-release is for the M3 milestone.
M4 dateThe date of the release PR availability or the date of the release of the API version after approval of its release PR. Update this field with each release created between M3 and M4. The last release date is the M4 date of the API. Format is yyyy-mm-dd
M4 releaseThe shortened link to the release PR when available for review, and once released, the shortened link to the release tag of the latest (pre-)release (release-candidate or public) for the API version e.g. r1.10. The last release is for the M4 milestone.
RM review

Review status and short link to the review issue for the M3 and M4 milestone release PR reviews: e.g. 

M4: OK ReleaseManagement/issues/88

M3: OK ReleaseManagement/issues/73

Any other relevant info

Comments

Comments on the API e.g. Previous API version(s) implemented by China Unicom, China Telecom, Vivo (Brazil), Deutsche Telekom (Germany), T-Mobile US, Telefonica (Spain). GSMA certified implementations by China Unicom.  (source: https://www.open-gateway.com/operators-map as of 2024-08-16) 

Contacts

Contact names for the API release: name1 @name2

...

NOTE: For Confluence administrators only: the content for the Confluence template is here: Use by RM admins only: Content for API release tracker template (v4v5 - 19/09/2024).