The API Release Process describes the creation of (pre-)releases of API versions through throughout the API lifecycle, and for a given meta-release.
For a meta-release, this the API Release Process targets the release of public API versions, aligned with the corresponding Commonalities and ICM public versions.
...
The release of a public API version is created once the release PR is approved for a meta-release.
- For M4, the release PR with is prepared. It concerns the public API version and all its public release assets are created in line with the target maturity status of the API version: initial or stable.
- If the PR is approved, the API version will be included in the meta-release.
- Inclusion in the meta-release is done by updating the API release tracker with the date and tag of the resulting GitHub release package.
A next subsequent release of a public API version is introduced if/when there are updates to the API (major/minor/patch).
| Info |
|---|
Initial public releases Please note that initial public API versions can be
|
...
Technically, a (pre-)release is created using the GitHub features and require:
- A GitHub issue for the release.
- A "pre-release PR" or "release PR" associated to this issue.
- If required (see table below), a GitHub release package (zip file of the whole API
Sub Projectrepository). - A GitHub release tag with the release number "rx.y" (see below).
Example of the use of the API release process
...
- Release numbers start with x=1 and y=1: r1.1.
- y is incremented by 1 at each subsequent (pre-)release (for alpha, release-candidate and public (pre-API versions)release, and for a maintenance release, e.g. rx.y+1.
- After a meta-release of an API release rx.y, the next release number for this API is rx+1.1 (y resets to 1).
- In case of maintenance of a release rx.y, the new public next release shall be rx.y+1. This new public A maintenance release replaces the previous one release in the meta-release.
The following table illustrates the continuous release numbering of an API version across the API release process.
| release type | API version | release number (tag) | release package | release package tag |
|---|---|---|---|---|
| N/A | work-in-progress | N/A | N/A | N/A |
| alpha pre-release | alpha | rx.1 ... rx.m | optional | optional: "pre-release" |
| pre-release candidate | release-candidate | rx.m+1 ... rx.n | mandatory | "pre-release" |
| public release | public | rx.n+1 | mandatory | "latest" |
| maintenance release | public | rx.n+2 ... rx.n+p | mandatory | "latest" |
...
- copy the API-Readiness-Checklist.md file(s) to the API Sub Project repository in the home/code folder.
- rename the file to include the prefix <API name> plus a dash ("-") e.g. quality-on-demand-API-Readiness-Checklist.md
- provide each release asset as indicated in the column corresponding to the release type (alpha, release-candidate, initial public release or stable public release)release type
- for an available asset
- update the Status column with "Y" (yes) if the release asset is available or fulfilled in the current release, or "N" (no) otherwise. Example: an intermediate alpha pre-release or release candidate may not yet provide all mandatory release assets for the release type.
- update the Comments column with the link to the asset (if applicable), and any other additional comments as needed
- update the Status column with "Y" (yes) if the release asset is available or fulfilled in the current release, or "N" (no) otherwise. Example: an intermediate alpha pre-release or release candidate may not yet provide all mandatory release assets for the release type.
- NOTE: the checklists of a (final) release candidate of an API version the latest pre-release and the checklist of its a subsequent public release are the same, while additional release assets are required for a subsequent stable public release of the the public API version.
Checklist explanation
The following table explains each of the release assets expected to be delivered in the API release.
Nr | API release assets | Explanation |
1 | API definition | This is the OAS API definition file (following the https://spec.openapis.org/oas/v3.0.3 format). It shall be present in the home/code/API_definition folders of the API Sub Project and validated using the linting rules in point 6. |
2 | Design guidelines from Commonalities applied | This refers to the guidelines in the API-Design-Guidelines.md document. A subset of these design guidelines have been mapped to corresponding linting rules provided by Commonalities, that can be executed against the OAS API definition file if linting is enabled for the Sub Project. For the design guidelines that cannot (yet) be verified by linting rules, the API Sub Project team shall ensure coverage manually. Ideally, a checklist of such guidelines would be provided by the Commonalities team. In particular, API Sub Project shall verify data type alignment to the Commonalities/artifacts/CAMARA_common.yaml |
3 | Guidelines from ICM applied | This refers to the guidelines described in the documents available in the IdentityAndConsentManagement / documents folder corresponds to a set of linting rules provided by ICM that are successfully executed against the OAS API definition file. Other guidelines that cannot be verified by linting rules shall be covered manually by the API Sub project team. Ideally, a checklist of such guidelines would be provided by the ICM team. |
| 4 | API versioning convention applied | This shall be checked through a linting rule added to the Commonalities rule set on the format of the version field in the OAS API definition file. API versioning is described in the API-Design-Guidelines.md document. |
5 | API documentation | The API specification shall include all the needed documentation. It shall include the section on security as described in the API Design Guidelines API documentation beyond the one embedded in the API definition file, shall be located in the home/documentation/API_documentation folder of the API Sub Project. It shall follow the Commonalities/documentation/API-DocumentationTemplate.md |
6 | User Stories | User Stories (it is recommended to have at least 2) need to be documented by the API Sub Project team. User Stories shall follow the template: Userstory-template.md and be located in the home/documentation/API_documentation folder of the API Sub Project. Please note that User Stories shall be provided when an API is first submitted to the CAMARA API backlog. |
7 | Basic API test cases & documentation | At least one Gherkin feature file is provided for the API in the Test_definitions folder of the API Sub Project covering sunny day scenarios and main error cases (of course you may provide more if available). Details can be found in the API Testing Guidelines (in Commonalities GitHub). Basic tests are sufficient for an initial public-release. |
8 | Enhanced API test cases & documentation | Gherkin feature files are provided for the API in the Test_definitions folder of the API Sub Project covering sunny and rainy day scenarios. Details can be found in the API Testing Guidelines (in Commonalities GitHub). Enhanced tests are required for a stable public-release. |
9 | Test result statement | A statement in a discussion issue of the API Sub Project by at least one of the API Sub Project members that the Gherkin feature files have been successfully executed against their (lab) API implementation. |
10 | API release numbering conventions applied | This is verified using the information on the release tracker page. The API release numbering is described here: |
11 | Change log updated | Change log need to be provided following the template and are located here: link tbd . |
12 | Previous public release was certified | The previous public API version had at least 1 certified implementation. Reference to at least 1 certification of the API is provided on the GSMA API market launch and certification page. |
...
Note 2: the addition of a Security review release asset beyond the Commonalities linting rules is for further study.
...
API readiness checklist
The following table indicates the assets of is the API readiness checklist that lists the assets that need to be provided for with the release of an API version depending for it to be ready for its (pre-)release. The required assets depend on
- its the API version type: alpha, release-candidate or public
- for public API versions, in addition, depending on its target status: initial or stable
...
- "M" indicates a mandatory release asset
- "O" indicates an optional release asset which may be provided with the release, if available.
Nr | API release assets | alpha |
release- candidate | initial public |
stable |
public | Status | Comments | |||||
1 | API definition | M | M | M | M | link | |
2 | Design guidelines from Commonalities applied | O | M | M | M | ||
3 | Guidelines from ICM applied | O | M | M | M | ||
| 4 | API versioning convention applied | M | M | M | M | ||
5 | API documentation | M | M | M | M | link | |
6 | Basic API test cases & documentation | O | M | M | M | link | |
7 | Enhanced API test cases & documentation | O | O | O | M | link | |
8 | Test result statement | O | O | O | M | link | |
9 | API release numbering convention applied | M | M | M | M | ||
10 | Change log updated | M | M | M | M | link | |
11 | Previous public-release was certified | O | O | O | M |
API releases - details
The GitHub release feature
...