DRAFT FOR REVIEW
...
- the expected (pre-)releases for alpha, release-candidate and public-release API versions need to be provided.
- minimally an initial public-release needs to be provided for the meta-release.
- each (pre-)release must include the required set of API release assets according to the API readiness checklist described below.
- API (pre-)releases are numbered (tagged) using the API release numbering guideline (see below).
Technically, an API release is created using GitHub features:
- A GitHub issue for the release
- A "release PR" for this issue
- A GitHub release package (zip file of the 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".
...
- Release numbers start with x=0 1 and y=1: r0r1.1.
- y is incremented by 1 at each subsequent alpha, release-candidate and public-release, and for a maintenance release, e.g. rx.y+1.
- After a meta-release of an API through release rx.y, the next release number for this API is rx+1.0 1 (y resets to 01).
- In case of maintenance of a release rx.y, the new public-release shall be rx.y+1.
...
| API version | release tag | release package | release package tag |
|---|---|---|---|
| work-in-progress | N/A | N/A | N/A |
| alpha | rx.1 ... rx.m | optional | optional [ "pre-release" ] |
| release-candidate | rx.m+1 ... rx.n | mandatory | "pre-release" |
| public-release | rx.n+1 | mandatory | "latest" |
...
How to create an API release ?
...