From 572b7b3654ab4cbf6d00ee77f50a97a80f60e438 Mon Sep 17 00:00:00 2001 From: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com> Date: Wed, 25 Mar 2026 00:48:54 +0100 Subject: [PATCH 1/4] Update README.md to point to the new material --- README.md | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 443a0a35..54915063 100644 --- a/README.md +++ b/README.md @@ -16,38 +16,29 @@ Repository to describe, develop, document and test the Release Management proces ## Release Process Information -**The Release Management documents describe the CAMARA meta-release and API release processes, contibute the API versioning guidelines, and provides the artifacts for use by API Sub projects to release an API version.** +**The Release Management documentation describes the CAMARA meta-release and API release processes, contibutes the API versioning guidelines, and provides the artifacts for use by API Sub projects to release an API version.** It contains the Release Management released documents and assests in the **documentation** folder: - - [API_Release_Guidelines.md](/documentation/API_Release_Guidelines.md) - An extract of the API release management process from the CAMARA wiki. - - [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md) - The checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public). - - [CHANGELOG_TEMPLATE.md](/documentation/CHANGELOG_TEMPLATE.md) - The template for creating CHANGELOG history of an API repository. - -It also contains the following in the **documentation/SupportingDocuments** folder: - - [CHANGELOG_EXAMPLE.md](/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) - Pointers to example CHANGELOG.md files over multiple releases created following the release management guidelines. + - [Release process documentation overview](documentation/README.md) - the main entry point for release management process documentation. + - [Automated API Release Process](/documentation/release-process/) - the automated release process for API repositories. + - [API Readiness Checklist](/documentation/readiness/api-readiness-checklist.md) - the checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public). + - In each API repository, the [CHANGELOG folder](/CHANGELOG) holds a file per release that tracks the CHANGELOG history across the API versions. Part of the content is generatedy by automation. For the reference documentation on API versioning, please see "Versioning" section in the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities). -The [CHANGELOG.md](/CHANGELOG.md) file describes the differences between releases of the Release Management repository. +The [CHANGELOG.md](/CHANGELOG.md) file provides the CHANGELOG history between releases of the Release Management repository. ## Release Management Wiki -Beyond the above reference release management information in GitHub, more information on the release process is available on the wiki. +Beyond the above reference release management documentation in GitHub, additional information is available on the [Release Managament wiki](https://lf-camaraproject.atlassian.net/wiki/x/VA7e). In particula you can find there information about: -* **Meta-releases of CAMARA** +* **Meta-releases** - * [Meta-release Plans](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) + * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) * [Meta-release Process](https://lf-camaraproject.atlassian.net/wiki/x/Zwne) -* **API release management** - * [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine) - * [API Release Tracking Process](https://lf-camaraproject.atlassian.net/wiki/x/ZhHe) - * [More on API Readiness Checklist](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14559630/API+Release+Process#API-readiness-checklist) - * [More on API Versioning](https://lf-camaraproject.atlassian.net/wiki/x/3yLe) - -More information about processes and release numbering for Commonalities and ICM can be found here: - - * [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) +* **Commonalities and ICM releases** + * More information about processes and release numbering for Commonalities and ICM can be found here: [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) ## Contributing * Meetings are held virtually From 5f0f6eb6d83c2ce1044a5668ace7e5d2075a04e0 Mon Sep 17 00:00:00 2001 From: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com> Date: Wed, 25 Mar 2026 00:58:18 +0100 Subject: [PATCH 2/4] Update README to clarify API versioning and CHANGELOG Removed duplicate reference to API versioning documentation and added a note about the CHANGELOG file for the Release Management repository. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 54915063..a05b7386 100644 --- a/README.md +++ b/README.md @@ -23,22 +23,23 @@ It contains the Release Management released documents and assests in the **docum - [Automated API Release Process](/documentation/release-process/) - the automated release process for API repositories. - [API Readiness Checklist](/documentation/readiness/api-readiness-checklist.md) - the checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public). - In each API repository, the [CHANGELOG folder](/CHANGELOG) holds a file per release that tracks the CHANGELOG history across the API versions. Part of the content is generatedy by automation. - -For the reference documentation on API versioning, please see "Versioning" section in the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities). - -The [CHANGELOG.md](/CHANGELOG.md) file provides the CHANGELOG history between releases of the Release Management repository. + - For the reference documentation on API versioning, please see "Versioning" section in the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities). ## Release Management Wiki -Beyond the above reference release management documentation in GitHub, additional information is available on the [Release Managament wiki](https://lf-camaraproject.atlassian.net/wiki/x/VA7e). In particula you can find there information about: +Beyond the above reference release management documentation in GitHub, additional information is available on the [Release Managament wiki](https://lf-camaraproject.atlassian.net/wiki/x/VA7e). In particular, you can find there information about: * **Meta-releases** - * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) - * [Meta-release Process](https://lf-camaraproject.atlassian.net/wiki/x/Zwne) + * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) - List of ongoing and past meta-releases and their contained APIs. + * [Meta-release Process](https://lf-camaraproject.atlassian.net/wiki/x/Zwne) - the meta-release milestone description and their related activities and time-line. * **Commonalities and ICM releases** - * More information about processes and release numbering for Commonalities and ICM can be found here: [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) + * [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) - More information about processes and release numbering for Commonalities and ICM releases. + +## Release Management repository + +The [CHANGELOG.md](/CHANGELOG.md) file provides the CHANGELOG history between releases of the Release Management repository. ## Contributing * Meetings are held virtually From 9c78eb82612b58fae71739cc8370d7fee8aef893 Mon Sep 17 00:00:00 2001 From: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com> Date: Wed, 25 Mar 2026 01:00:09 +0100 Subject: [PATCH 3/4] fix typos Updated capitalization for consistency. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a05b7386..f4deaccb 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,11 @@ Beyond the above reference release management documentation in GitHub, additiona * **Meta-releases** - * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) - List of ongoing and past meta-releases and their contained APIs. + * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) - list of ongoing and past meta-releases and their contained APIs. * [Meta-release Process](https://lf-camaraproject.atlassian.net/wiki/x/Zwne) - the meta-release milestone description and their related activities and time-line. * **Commonalities and ICM releases** - * [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) - More information about processes and release numbering for Commonalities and ICM releases. + * [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) - more information about processes and release numbering for Commonalities and ICM releases. ## Release Management repository From dd9b8f145e10c707152507fada0b91ef482c3acf Mon Sep 17 00:00:00 2001 From: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com> Date: Wed, 25 Mar 2026 16:28:23 +0100 Subject: [PATCH 4/4] Revise README for clarity and consistency Updated terminology and clarified the API Release Process documentation. Improved consistency and corrected typographical errors. --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f4deaccb..4438010b 100644 --- a/README.md +++ b/README.md @@ -10,36 +10,48 @@ Repository to describe, develop, document and test the Release Management process. ## Scope -* Guidelines and assets for Release Management in CAMARA +* Guidelines and artefacts for Release Management in CAMARA * Describe, develop, document and apply the deliverables * Started: November 2023 -## Release Process Information +## Introduction -**The Release Management documentation describes the CAMARA meta-release and API release processes, contibutes the API versioning guidelines, and provides the artifacts for use by API Sub projects to release an API version.** +The Release Management documentation describes -It contains the Release Management released documents and assests in the **documentation** folder: - - [Release process documentation overview](documentation/README.md) - the main entry point for release management process documentation. +- the automated API release process (see GitHub links below) +- the CAMARA meta-release process (see Wiki links below) +- the Commonalities and ICM release process (see Wiki links below) +- the API versioning guidelines (input to Commonalities, see GitHub links below) +- the artifacts enabling the automatied API release rpocess (see GitHub link below). + +NOTE: the automation process also leverages support from the `project-administration` and the `tooling` repositories. + +## API Release Process + +The API Release Process documentation and artifacts are located in the **`documentation`** folder of the Release Management repository: + - [Release process documentation overview](documentation/README.md) - the main entry point for automated release process documentation. - [Automated API Release Process](/documentation/release-process/) - the automated release process for API repositories. - - [API Readiness Checklist](/documentation/readiness/api-readiness-checklist.md) - the checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public). - - In each API repository, the [CHANGELOG folder](/CHANGELOG) holds a file per release that tracks the CHANGELOG history across the API versions. Part of the content is generatedy by automation. - - For the reference documentation on API versioning, please see "Versioning" section in the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities). + - [API Readiness Checklist](/documentation/readiness/api-readiness-checklist.md) - the checklist that defines release readiness of the API according to its terget release status (alpha, release-candidate, public). + - In each API repository, the [CHANGELOG folder](/CHANGELOG) holds a file per release that tracks the CHANGELOG history across the API versions. Part of its content is generated by automation. + - For the reference documentation on API versioning, please see "Versioning" section in the CAMARA API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities). ## Release Management Wiki -Beyond the above reference release management documentation in GitHub, additional information is available on the [Release Managament wiki](https://lf-camaraproject.atlassian.net/wiki/x/VA7e). In particular, you can find there information about: +Beyond the above reference release management documentation in GitHub, additional information is available on the [Release Management wiki](https://lf-camaraproject.atlassian.net/wiki/x/VA7e). In particular, you can find there information about: -* **Meta-releases** +* **Meta-release process** - * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) - list of ongoing and past meta-releases and their contained APIs. + * [Meta-releases](https://lf-camaraproject.atlassian.net/wiki/x/bmTe) - list of ongoing and past meta-releases, their contained APIs and their associated Commonalities and ICM releases. * [Meta-release Process](https://lf-camaraproject.atlassian.net/wiki/x/Zwne) - the meta-release milestone description and their related activities and time-line. -* **Commonalities and ICM releases** +* **Commonalities and ICM release process** * [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) - more information about processes and release numbering for Commonalities and ICM releases. ## Release Management repository -The [CHANGELOG.md](/CHANGELOG.md) file provides the CHANGELOG history between releases of the Release Management repository. +The [CHANGELOG.md](/CHANGELOG.md) file provides the CHANGELOG history between releases of the Release Management repository. + +The automated release process has been introduced with the Spring26 meta-release. ## Contributing * Meetings are held virtually