Versions Compared

Key

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

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

...

  • Create an API release tracking page (see details below). This needs to be done only once for an each API in of an API Sub-project.

  • Create an API release tracker. This needs to be done for each API version that is planned to be released.

...

Create an API release tracker for an API release

...

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 Planning Releasing APIs, e.g. geofencing
GroupThe name of the GitHub repository for the API Sub-project, e.g. DeviceLocation 
RepositoryThe link to GitHub repository for the API Sub-project, e.g. https://github.com/camaraproject/DeviceLocation 
Target versionThe API version that you plan to publish in the indicated meta-release, e.g. 1.0.0
Target scopeThe link to a GitHub issue called "Scope for target version" which needs to be created and filled before and resolved at M3
M3 dateThe date when the latest alpha API version is ready and stable to create the 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 release-candidate API version for M5 submission is ready. Once this date is provided by the API project team, the Release Management team can check the API release-candidate for acceptance and submit to the TSC for approval. Format is yyyy-mm-dd
API versionThe name of the latest pre-release (initial, alpha or release-candidate) API version to be updated at M3 and M4 date, e.g. qod-0.10.0-rc.2 or qod-0.10.1)
pre-release tagThe tag of the latest pre-release (initial, alpha or release-candidate) for the API version e.g. https://github.com/camaraproject/QualityOnDemand/releases/tag/r0.10
M5 dateThe 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. After this date, if approval is obtained, the API Sub-project shall prepare the public-release API version and its release assets for use in the meta-release. Format is yyyy-mm-dd
public-release tagThe link to the public-release tag of the API version. This field is updated once the public-release is ready, e.g.  https://github.com/camaraproject/QualityOnDemand/releases/tag/r1.0 
Comment

Additional information on the API version, e.g.

M4: API approved by TSC 

API release phase-out planned, retirement date planned, etc. Date format is yyyy-mm-dd.

Contacts

Contact names for the API release

...

Page Properties

Meta-release

Fall24

API name

qod
GroupQualityOnDemand 
Repositoryhttps://github.com/camaraproject/QualityOnDemand 
Target version1.0.0
Target scopeGitHub issue link "Scope for target version" to be resolved at M3
M3 dateyyyy-mm-dd
M4 dateyyyy-mm-dd
API versionqod-0.10.0-rc.2
pre-release taghttps://github.com/camaraproject/QualityOnDemand/releases/tag/r0.10
M5 dateyyyy-mm-dd
public-release taghttps://github.com/camaraproject/QualityOnDemand/releases/tag/r1.0 
Comment

API approved by TSC (M4)

Contacts

@ name1, @ name2

...