Versions Compared

Key

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

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

...

Meta-release

The name of the meta-release, e.g. Fall24

API name

The API name. See the definition of API name on this page: API Release Process, e.g. geofencing
GroupThe name of the GitHub repository for the API Sub Project, e.g. DeviceLocation 
RepositoryThe shortened link to GitHub repository for the API Sub Project, e.g. DeviceLocation 
Target versionThe API version that you plan to publish in the indicated meta-release, e.g. 1.0.0
Target scopeThe shortened link to a GitHub issue called "Scope for target version" which needs to be created latest at M1 and resolved by M3 e.g. DeviceLocation/issues/58
Target maturityIndicates the maturity of the API version that is targeted in the upcoming meta-release: choose one of initial / stable.
Readiness checklistThe shortened link to the API readiness checklist for the API. The template of the checklist can be found here: (link to release management repo tbd)
M3 dateThe date when the first release-candidate API version is ready. This is the starting point for creating the final release-candidate API version for M4. After this date, only bug fixes and necessary non-breaking changes can be made to the API. Format is yyyy-mm-dd
M4 dateThe date when the final release-candidate API version for M5 submission is ready. This is the starting point for creating the public-release API version for M5. Once this date is provided by the API project team, the Release Management team can check the release-candidate API version for acceptance and submit to the TSC for approval. Format is yyyy-mm-dd
API versionThe version of the latest pre-release (alpha or release-candidate) API version to be updated at M3 and M4 date, e.g. 0.2.0_alpha.3, 0.10.0-rc.2, 0.10.1, 1.0.0-rc.5)
pre-release tagThe shortened release tag of the latest pre-release (alpha or release-candidate) for the API version e.g. QualityOnDemand/releases/tag/r0.10
M5 date

The date by which the Release Management team has checked the release-candidate API version provided at the M4 date and the API is approved by the TSC.

The link to the PR for public-release API version shall be included in this field when available 

After this date, if approval is obtained, the API Sub Project shall commit the PR of the public-release API version and its release assets for use in the meta-release. Format is yyyy-mm-dd. 

The link to the PR shall be removed after the commit is done.

public-release tagThe shortened release tag of the public-release API version. This field is updated once the public-release has been created, e.g.  QualityOnDemand/releases/tag/r1.0 
Comments

Field for exchanging information with RM team, for example 

M3: alpha ready for RM

M3: checked by RM - NOK - missing sunny test cases

M4: ready for RM

M4: ready for approval by TSC

M4: approved by TSC 

M5: public-release done

M5: API version retirement planned by yyyy-mm-dd.

Contacts

Contact names for the API release: name1 @name2

...

This is the baseline for the Confluence template for API release tracker pages (to be used only by Confluence Admin to copy to the template page).

Start of template (please copy the below  red lines up to and including the last line of this page to the template):

Add the meta-release label to the page by clicking on the label icon at the top of the page and adding "camara-<meta-release name>", e.g. camara-fall24, camara-spring25, etc.

...

Page Properties

Meta-release

Fall24

API name

<api-name>
Group<API group name>
Repository<link to Sub Project> 
Target version<major.minor.patch>
Target scope<link to GitHub issue>
Target maturityinitial
Readiness checklist<link to file in repo>
M3 dateyyyy-mm-dd
M4 dateyyyy-mm-dd
API version<OAS version field>
pre-release tag<link>
M5 dateyyyy-mm-dd
public-release tag<link>
Comments


Contacts

@ name1, @ name2

...