Versions Compared

Key

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

DRAFT FOR REVIEW

...

  • the expected alpha, release-candidates and public-release API versions need to be (pre-)released
  • minimally an initial public-release need to be provided
  • each (pre-)release must provide 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
  • If required, 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".

...

  • a release tag (following the release numbering guidelines below) on the main or on a maintenance release branch, identifying the release of the API version.
  • a release package containing the API's repository with the corresponding API release assets for the released API version (zip file). This is optional for intermediate alpha releases.

API releases are numbered (tagged) following the API release numbering guideline (see above).

...