CAMARA release management process requires each API project to plan and track their API releases so that meta-release can be created.
API release tracking consists in 2 steps:
Create an API release tracking page (see details below). This needs to be done only once for each API 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.
The following sections provide the details for each step.
Create an API release tracking page
Each API Sub-project needs to track the release planning for its APIs.
For each API managed in the API Sub-project, the API release tracking page for that API is to be created under the API Sub-project wiki home page. This is done as follows:
- Copy the following page <API name> API release tracking, indicating your API Sub-project home page as the parent page.
- Replace the <API name> in the copied page title with the API name (i.e. the API name is the API path segment as defined here: API Release Process)
Create an API release tracker for an API release
For each new release of an API (e.g. at M0), a dedicated API release tracker (page) is created to plan and track the progress of that API release.
To create an API release tracker, go to the API's release tracking page (as created per above section) and do the following:
- Push the "Add API release tracker" button to create the tracker page for the new API release.
- In the page title, put the <API name> and the <Target version> as described in the below table, e.g. geofencing 1.0.0
- Complete the table on the page following the indications in the table below.
- Add the meta-release label to the page (e.g. camara-fall24)
- Maintain the page up-to-date to reflect the progress of the API release through the release cycle.
API release tracker content
Each API release tracker has the below table that serves as the source for tracking API release progress.
In particular, this content is pulled into the meta-release planning page (based on the page label).
IMPORTANT
The left column of this table shall not be changed. If you want to add a new field, please contact the release management team through the mailing list to request the addition of the field and the reason to add it. Adding a field will require a manual update to ALL release tracker pages.
Explanations:
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 |
| Group | The name of the GitHub repository for the API Sub-project, e.g. DeviceLocation |
| Repository | The link to GitHub repository for the API Sub-project, e.g. https://github.com/camaraproject/DeviceLocation |
| Target version | The API version that you plan to publish in the indicated meta-release, e.g. 1.0.0 |
| Target scope | The link to a GitHub issue called "Scope for target version" which needs to be created and filled before and resolved at M3 |
| M3 date | The 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 date | The 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 version | The 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 tag | The 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 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. 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 tag | The 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 |
Example API release tracker (Note this is also the content of the API release tracker template page).
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.
Remove these lines in red.