The Release Management process targets the creation of public-releases of API versions, aligned with the Commonalities and ICM release in a given meta-release.
...
Technically, an API release is created using GitHub features:
- A GitHub issue for the release
- A "release PR" for this issue
- If required, a GitHub release package (zip file of the whole API Sub Project repository)
- A GitHub release tag with the release name rx.y
API release numbering
API release numbers are GitHub tags of the format "rx.y".
...
The PATCH of the API for the maintenance release will be merged into a next MAJOR or MINOR API release on the main branch
- The maintenance branch shall continue to exist for further PATCH updates of this API version x.y.z+1 (incrementing z) as long as needed.
API readiness checklist
To release an API version, an API Sub Project needs to provide the required release assets as specified in the API Readiness Checklist (see description below).
The template for the checklist is the API-Readiness-Checklist.md file to be copied by API Sub Projects is be provided located in the Release Management / documentation repository (link tbd).
An API version for which a release is created needs to provide the related set of release assets. The For the release of a given API version, API Sub Project needs to
- copy the <API name>-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>record the availability of "-" e.g. qod-API-Readiness-Checklist.md
- provide each release asset in the API readiness checklist file as listed as indicated in the column corresponding to the release type (alpha, release-candidate, initial public-release or stable public-release)
- for an available asset
- update the Status column with "Y" (yes) or "N" (no) when if the release asset is available or fulfilled in the current release. You can add comments as needed, or "N" (no) otherwise. Example: an intermediate alpha or release-candidate release may not yet provide all mandatory release assets for the release type yet.
- 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) or "N" (no) when if the release asset is available or fulfilled in the current release. You can add comments as needed, or "N" (no) otherwise. Example: an intermediate alpha or release-candidate release may not yet provide all mandatory release assets for the release type yet.
- NOTE: the checklists of a (final) release-candidate of an API version and the checklist of its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release of the API version.
Explanations
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: Commonalities/documentation/SupportingDocuments/CHANGELOG_TEMPLATE.md . |
12 | Previous public-release was certified | The previous public-release 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.
Checklist per API version type
...