...
Fall24
2024-07-19: M3 milestone - new date: 2024-07-26 & preparation hints (to rm mailing list)
Dear all,Please be reminded
In the light of the
...
upcoming M3 milestone
...
, please find the following point to get prepared
...
:
the TSC has shifted the M3 date to 2024-07-26,but earlier is very welcome- at this date it is sufficient to have the release PR forthe API release-candidate.
- please put the link to the release PR in the (pre)-release tag field on the API release tracker when your PR is ready for review
- in this release PR you need to include:
- any updates to the readme.md as needed
- the update of the changelog.md file
- see example here: ReleaseManagement/documentation/CHANGELOG_EXAMPLE.md
HINT: create a "draft release" with GitHub to see the relevant changes since the previous version and select relevant PRs, reformulate as needed and sort them into the categories of the changelog.
- the update of the yaml file with the concerned API version and URL
A reminder that the API version (x-y-z-rc.1) is different from the release number of the pre-release (which will be r1.1).
- the update of the API readiness checklist with all required content for the release-candidate
- exceptionally, although the checklist mandates to provide the basic test cases with the release-candidate, for this first meta-release, the Sub Projects are allowed to delay these to M4. However the earlier the test cases are provided, the longer the time to actuall test any available API implementation. Please use the comment field in the checklist to indicate the delay if any. M3 will not be blocked on this point.
- do not use release branches anymore: all releases are to happen using the GitHub release feature from the main branch and setting release tags on the main branch. If this is an issue for M3, this can be resolved for M4.
- please notify the Release Management team to review the PR by adding https://github.com/orgs/camaraproject/teams/release-management_maintainers as reviewers to the release PR.
...
- check that your servers object in the yaml looks as follows:
servers:
- url: '{apiRoot}/yourapiname/v0.yrc1 or v1rc1or v1rc1'
variables:
apiRoot:
...
Questions or comments ? create a Release Mgmt issue, mail the RM mailing list or look at the FAQ - find both .
The links to the latter 2, and more generally on the API release process, are on the RM wiki and in GitHub.
Thanks !
The CAMARA Release Management team
...