From ba05ab0db7a589b721b14d42b66f36b718ae9ce0 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:02:14 +0200 Subject: [PATCH 01/16] Update README.md update links and content --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 01b5728..679c91d 100644 --- a/README.md +++ b/README.md @@ -14,31 +14,33 @@ Repository to describe, develop, document and test the Release Management proces * Describe, develop, document and test the deliverables * Started: November 2023 -## Release Information +## Release Process Information -This projects constains the following (documentation folder): +This projects constains the following documentation: -* API release guidelines -* API readiness checklist +* [API release guidelines](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md) +* [API readiness checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) +* [CHANGELOG TEMPLATE](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md) +* [CHANGELOG EXAMPLE]() -More detailed information can be found in the below wiki pages. +Note: the reference documentation on API versioning is here: [Commonalities API design guidelinse (section 5)](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) -Some quick-access links to content within the wiki: +## Release Management Wiki + +Beyond the above reference release management information in GitHub, more information on processes for API Sub Projects is available on the wiki. * **Meta-Releases of CAMARA** - * **[Meta-Release Fall24](https://wiki.camaraproject.org/x/cgB0AQ)** - * [Meta-release Milestones](https://wiki.camaraproject.org/x/16N3) + * **[Meta-Release plans](https://wiki.camaraproject.org/x/2qN3)** * [Meta-release Process](https://wiki.camaraproject.org/x/G7N3) -* Processes for API Sub Projects - +* **API release management** * [API Release Process](https://wiki.camaraproject.org/x/AgAVAQ) - * [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist) - * [API release tracking process](https://wiki.camaraproject.org/x/HQBFAQ) - * [API versioning](https://wiki.camaraproject.org/display/CAM/API+versioning) + * [API Release Tracking Process](https://wiki.camaraproject.org/x/HQBFAQ) + * [More on API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist) + * [More on API versioning](https://wiki.camaraproject.org/display/CAM/API+versioning) -* Processes and release numbering for Commonalities and ICM +More information about processes and release numbering for Commonalities and ICM can be found here: * [Commonalities and ICM Release Process](https://wiki.camaraproject.org/display/CAM/Meta-release+Process#MetareleaseProcess-CommonalitiesandICM) From 85f691cac61a3efdb28b412f5c54b3052dd2da27 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:11:28 +0200 Subject: [PATCH 02/16] Rename documentation/CHANGELOG_EXAMPLE.md to documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md moved CHANGELOG EXAMPLE to Supporting Documents --- documentation/{ => SupportingDocuments}/CHANGELOG_EXAMPLE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename documentation/{ => SupportingDocuments}/CHANGELOG_EXAMPLE.md (100%) diff --git a/documentation/CHANGELOG_EXAMPLE.md b/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md similarity index 100% rename from documentation/CHANGELOG_EXAMPLE.md rename to documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md From 8ceae33703cbd67ed7523e5d146acd36c229f1b8 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:15:51 +0200 Subject: [PATCH 03/16] Delete documentation/SupportingDocuments/README.MD --- documentation/SupportingDocuments/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 documentation/SupportingDocuments/README.MD diff --git a/documentation/SupportingDocuments/README.MD b/documentation/SupportingDocuments/README.MD deleted file mode 100644 index 37aa0ff..0000000 --- a/documentation/SupportingDocuments/README.MD +++ /dev/null @@ -1 +0,0 @@ -This README.MD can be deleted when the first file is added to this directory. From 1110b6d3333d8d4a505e557e98cfb5da9b65a5f7 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:26:45 +0200 Subject: [PATCH 04/16] Update README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 679c91d..177ddaf 100644 --- a/README.md +++ b/README.md @@ -18,27 +18,28 @@ Repository to describe, develop, document and test the Release Management proces This projects constains the following documentation: -* [API release guidelines](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md) -* [API readiness checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) -* [CHANGELOG TEMPLATE](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md) -* [CHANGELOG EXAMPLE]() +* [API Release Guidelines](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md) +* [API Readiness Checklist (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) +* [CHANGELOG (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md) -Note: the reference documentation on API versioning is here: [Commonalities API design guidelinse (section 5)](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) +An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.MD) + +The reference documentation on API versioning is here: [Commonalities API design guidelines (section 5)](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) ## Release Management Wiki -Beyond the above reference release management information in GitHub, more information on processes for API Sub Projects is available on the wiki. +Beyond the above reference release management information in GitHub, more information on the release process is available on the wiki. -* **Meta-Releases of CAMARA** +* **Meta-releases of CAMARA** - * **[Meta-Release plans](https://wiki.camaraproject.org/x/2qN3)** + * [Meta-release Plans](https://wiki.camaraproject.org/x/2qN3) * [Meta-release Process](https://wiki.camaraproject.org/x/G7N3) * **API release management** * [API Release Process](https://wiki.camaraproject.org/x/AgAVAQ) * [API Release Tracking Process](https://wiki.camaraproject.org/x/HQBFAQ) * [More on API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist) - * [More on API versioning](https://wiki.camaraproject.org/display/CAM/API+versioning) + * [More on API Versioning](https://wiki.camaraproject.org/display/CAM/API+versioning) More information about processes and release numbering for Commonalities and ICM can be found here: From 8f10137da5d94e23e5cdcdcabb15ac9439c3ba8f Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:29:11 +0200 Subject: [PATCH 05/16] Update README.md added a release number r1.0.0 in the scope. Release tag is to be done --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 177ddaf..7b3adf9 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Repository to describe, develop, document and test the Release Management proces * Guidelines and assets for Release Management in CAMARA * Describe, develop, document and test the deliverables * Started: November 2023 +* First release: r1.0.0 (July 2024) ## Release Process Information From 5b8ae4d12d8be2fdf7f3088bf62864611b97fead Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:33:02 +0200 Subject: [PATCH 06/16] Update API-Readiness-Checklist.md Corrected link to wiki --- documentation/API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-Readiness-Checklist.md b/documentation/API-Readiness-Checklist.md index 5931778..390508d 100644 --- a/documentation/API-Readiness-Checklist.md +++ b/documentation/API-Readiness-Checklist.md @@ -24,4 +24,4 @@ To fill the checklist: Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. -The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ) +The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist). From 084203efeae225a407b549f9d82fd783dccd927e Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 12:58:16 +0200 Subject: [PATCH 07/16] Update API_Release_Guidelines.md update links and did a few minor tweaks --- documentation/API_Release_Guidelines.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/API_Release_Guidelines.md b/documentation/API_Release_Guidelines.md index 5b2dda9..9b1a9da 100644 --- a/documentation/API_Release_Guidelines.md +++ b/documentation/API_Release_Guidelines.md @@ -108,7 +108,7 @@ This section lists the steps to release an API version. More details can be foun On the main branch, * develop the API scope in a "work-in-progress mode" (API version = wip and version in URL is vwip). -* make sure to create the required release assets and record them in the `API-Readiness-Checklist.md` file +* make sure to create the required release assets and record them in the `APIname-API-Readiness-Checklist.md` file **Create the release PR** @@ -116,8 +116,8 @@ Once the defined scope and required stability is reached, create the (pre-)relea A (pre-)release PR provides only the following changes:  * update of the version information in the API OAS definition files (no "wip" in the version field and base URL of any of the API files). -* update the `API-Readiness-Checklist.md` file ensuring all required release assets are available. If this file not yet available, create a local copy under the /documentation folder and prefix it with the respective API name (copy it from [ReleaseManagement/documentation/API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md). -* update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy it from [ReleaseManagement/documentation/CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md). See also the example available there. +* update the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md), and prefix it with the API name. +* update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy the [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md). See also the example available in the [SupportingDocuments folder](https://github.com/camaraproject/ReleaseManagement/tree/main/documentation/SupportingDocuments). * add a new section at the top of the file for the release and each API version with the following content: * for each first alpha or release-candidate API version, all changes since the release of the previous public API version * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release @@ -125,7 +125,7 @@ A (pre-)release PR provides only the following changes:  * update of the API repository `README.md` file (as necessary) **Create the release** -* manage the release PR approval +* manage the release PR approval with the Release Management team * merge the approved release PR * create the release: * an API release is created using the GitHub release feature (a release tag and, optionally, a release package). From 389a3b002fac2093232c437e5f38852e978a0a71 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:03:44 +0200 Subject: [PATCH 08/16] Update API_Release_Guidelines.md a few tweeks --- documentation/API_Release_Guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_Release_Guidelines.md b/documentation/API_Release_Guidelines.md index 9b1a9da..1c50021 100644 --- a/documentation/API_Release_Guidelines.md +++ b/documentation/API_Release_Guidelines.md @@ -108,7 +108,7 @@ This section lists the steps to release an API version. More details can be foun On the main branch, * develop the API scope in a "work-in-progress mode" (API version = wip and version in URL is vwip). -* make sure to create the required release assets and record them in the `APIname-API-Readiness-Checklist.md` file +* make sure to create the required release assets and record them in the `APIname-API-Readiness-Checklist.md` file. If not yet available, copy the template [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md), and prefix it with the API name. **Create the release PR** @@ -116,7 +116,7 @@ Once the defined scope and required stability is reached, create the (pre-)relea A (pre-)release PR provides only the following changes:  * update of the version information in the API OAS definition files (no "wip" in the version field and base URL of any of the API files). -* update the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md), and prefix it with the API name. +* complete the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md), and prefix it with the API name. * update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy the [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md). See also the example available in the [SupportingDocuments folder](https://github.com/camaraproject/ReleaseManagement/tree/main/documentation/SupportingDocuments). * add a new section at the top of the file for the release and each API version with the following content: * for each first alpha or release-candidate API version, all changes since the release of the previous public API version From 65bec7ed482ab8a18c053785167a0cab859aeb77 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:21:01 +0200 Subject: [PATCH 09/16] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b3adf9..24a6f77 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Repository to describe, develop, document and test the Release Management proces ## Release Process Information -This projects constains the following documentation: +This projects contains the following documentation: * [API Release Guidelines](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md) * [API Readiness Checklist (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) From e8525c086a344e50488c6b39fb041545f36fdf08 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:21:38 +0200 Subject: [PATCH 10/16] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24a6f77..b8ca87a 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Repository to describe, develop, document and test the Release Management proces This projects contains the following documentation: -* [API Release Guidelines](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md) +* [API Release Guidelines](/documentation/API_Release_Guidelines.md) * [API Readiness Checklist (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) * [CHANGELOG (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md) From cabb26585bcde8ebd32996d175f66a39a06c3420 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:21:50 +0200 Subject: [PATCH 11/16] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8ca87a..f8ba7ac 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Repository to describe, develop, document and test the Release Management proces This projects contains the following documentation: * [API Release Guidelines](/documentation/API_Release_Guidelines.md) -* [API Readiness Checklist (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) +* [API Readiness Checklist (template for copying)](/documentation/API-Readiness-Checklist.md) * [CHANGELOG (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md) An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.MD) From 01305c931e97e7bbe3773f43e2b37bc39fcfa9e2 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:22:18 +0200 Subject: [PATCH 12/16] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8ba7ac..243646f 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ This projects contains the following documentation: * [API Release Guidelines](/documentation/API_Release_Guidelines.md) * [API Readiness Checklist (template for copying)](/documentation/API-Readiness-Checklist.md) -* [CHANGELOG (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md) +* [CHANGELOG (template for copying)](/documentation/CHANGELOG_TEMPLATE.md) An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.MD) From b8711f0130d7f3b37e26daeca3bda77474d54e97 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:22:38 +0200 Subject: [PATCH 13/16] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 243646f..153dcb0 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ This projects contains the following documentation: * [API Readiness Checklist (template for copying)](/documentation/API-Readiness-Checklist.md) * [CHANGELOG (template for copying)](/documentation/CHANGELOG_TEMPLATE.md) -An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.MD) +An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) The reference documentation on API versioning is here: [Commonalities API design guidelines (section 5)](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) From b7cb54a1cd931eaa6b64ac4edc97117a1f32377c Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:23:00 +0200 Subject: [PATCH 14/16] Update documentation/API_Release_Guidelines.md Co-authored-by: Herbert Damker --- documentation/API_Release_Guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_Release_Guidelines.md b/documentation/API_Release_Guidelines.md index 1c50021..fbfca2f 100644 --- a/documentation/API_Release_Guidelines.md +++ b/documentation/API_Release_Guidelines.md @@ -108,7 +108,7 @@ This section lists the steps to release an API version. More details can be foun On the main branch, * develop the API scope in a "work-in-progress mode" (API version = wip and version in URL is vwip). -* make sure to create the required release assets and record them in the `APIname-API-Readiness-Checklist.md` file. If not yet available, copy the template [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md), and prefix it with the API name. +* make sure to create the required release assets and record them in the `APIname-API-Readiness-Checklist.md` file. If not yet available, copy the template [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md), and prefix it with the API name. **Create the release PR** From bc8c1095be73c3b8987bda8ff4d819832972d384 Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:23:25 +0200 Subject: [PATCH 15/16] Update documentation/API_Release_Guidelines.md Co-authored-by: Herbert Damker --- documentation/API_Release_Guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_Release_Guidelines.md b/documentation/API_Release_Guidelines.md index fbfca2f..c396e49 100644 --- a/documentation/API_Release_Guidelines.md +++ b/documentation/API_Release_Guidelines.md @@ -116,7 +116,7 @@ Once the defined scope and required stability is reached, create the (pre-)relea A (pre-)release PR provides only the following changes:  * update of the version information in the API OAS definition files (no "wip" in the version field and base URL of any of the API files). -* complete the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md), and prefix it with the API name. +* complete the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md), and prefix it with the API name. * update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy the [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md). See also the example available in the [SupportingDocuments folder](https://github.com/camaraproject/ReleaseManagement/tree/main/documentation/SupportingDocuments). * add a new section at the top of the file for the release and each API version with the following content: * for each first alpha or release-candidate API version, all changes since the release of the previous public API version From b1f587e7773cb85c6839607f18a62f1f5c5d96bb Mon Sep 17 00:00:00 2001 From: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> Date: Mon, 22 Jul 2024 18:23:43 +0200 Subject: [PATCH 16/16] Update documentation/API_Release_Guidelines.md Co-authored-by: Herbert Damker --- documentation/API_Release_Guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_Release_Guidelines.md b/documentation/API_Release_Guidelines.md index c396e49..f6258ce 100644 --- a/documentation/API_Release_Guidelines.md +++ b/documentation/API_Release_Guidelines.md @@ -117,7 +117,7 @@ Once the defined scope and required stability is reached, create the (pre-)relea A (pre-)release PR provides only the following changes:  * update of the version information in the API OAS definition files (no "wip" in the version field and base URL of any of the API files). * complete the `APIname-API-Readiness-Checklist.md` file ensuring all required release assets are available. If not yet available, copy the template [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md), and prefix it with the API name. -* update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy the [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/CHANGELOG_TEMPLATE.md). See also the example available in the [SupportingDocuments folder](https://github.com/camaraproject/ReleaseManagement/tree/main/documentation/SupportingDocuments). +* update the `CHANGELOG.md` file in the home of the API repository. If not yet available, copy the [CHANGELOG_TEMPLATE.md](/documentation/CHANGELOG_TEMPLATE.md). See also the example available in the [SupportingDocuments folder](/documentation/SupportingDocuments). * add a new section at the top of the file for the release and each API version with the following content: * for each first alpha or release-candidate API version, all changes since the release of the previous public API version * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release