From af29d6bd2cad3881f0971a55cf424215e0d91689 Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:20:18 +0200 Subject: [PATCH 01/11] Create CHANGELOG --- CHANGELOG | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CHANGELOG diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..0d41ea0 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,41 @@ +# Changelog Release Management + +## Table of Contents + +- **[r1.1](#r11)** + +# r1.1 + +## Release Notes + +**This is the first pre-release of the Release Management documents with version 0.1.0.** + +Content is based on the work done by the [Release Management Working Group](https://lf-camaraproject.atlassian.net/l/cp/scZC1AYy) and the results are located in the [Release Management repository](https://github.com/camaraproject/ReleaseManagement). + +**It provides the initial version of de guidelines describing how to releasing an API version, as well as the API-Readiness-Checklist template in which to record the availability of the artefacts required for the API release.** + +It contains the Release Management approved documents in the **documentation** folder: + - **[API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API_Release_Guidelines.md)** - An extract of the API Release Management process form the CAMARA wiki. + - **[API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API-Readiness-Checklist.md)** - The checklist to ensure release readiness of the API according to its release type (alpha, release-candidate, public). + +### Added +* Add API-Readiness-Checklist.md to RM project by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/29 +* Add API Release Guidelines to GitHub - extract of the API Release Pro… by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31 +* Added changelog template and example by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/36 and @hdamker in https://github.com/camaraproject/ReleaseManagement/pull/38 +* Update public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35 + +### Changed +N/A + +### Fixed +N/A + +### Removed +N/A + +## New Contributors +* @hdamker made their first contribution in https://github.com/camaraproject/ReleaseManagement/pull/8 +* @MarkusKuemmerle made their first contribution in https://github.com/camaraproject/ReleaseManagement/pull/21 +* @tanjadegroot made their first contribution in https://github.com/camaraproject/ReleaseManagement/pull/29 + +Full Changelog: https://github.com/nokia/camaraproject-ReleaseManagement/commits/r1.1 \ No newline at end of file From 31b396d34aca5d873d503293e7eab99c8985367d Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:20:37 +0200 Subject: [PATCH 02/11] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 01b5728..bae305e 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,13 @@ Repository to describe, develop, document and test the Release Management proces ## Release Information -This projects constains the following (documentation folder): +This is the first pre-release of the Release Management documents with version 0.1.0. -* API release guidelines -* API readiness checklist +It contains the Release Management approved documents in the **documentation** folder: + - [API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API_Release_Guidelines.md) - An extract of the API Release Management process form the CAMARA wiki. + - [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API-Readiness-Checklist.md) - The checklist (template to copy) to ensure release readiness of the API according to its release type (alpha, release-candidate, public). + - [CHANGELOG_TEMPLATE.md (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/CHANGELOG_TEMPLATE.md) + - An example of the CHANGELOG created per the release management process is here: [CHANGELOG_EXAMPLE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) More detailed information can be found in the below wiki pages. From afd166f2d479ef38d5f3d7933a06d98b9f3681c9 Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:21:41 +0200 Subject: [PATCH 03/11] Create VERSION.md --- VERSION.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 VERSION.md diff --git a/VERSION.md b/VERSION.md new file mode 100644 index 0000000..15a9196 --- /dev/null +++ b/VERSION.md @@ -0,0 +1 @@ +version: v0.1.0 From ffda14a1757a7f46d5bc2e7f40c2ae5a65b275c0 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Wed, 9 Oct 2024 18:20:04 +0200 Subject: [PATCH 04/11] Update CHANGELOG Co-authored-by: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> --- CHANGELOG | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG b/CHANGELOG index 0d41ea0..41420be 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -12,7 +12,7 @@ Content is based on the work done by the [Release Management Working Group](https://lf-camaraproject.atlassian.net/l/cp/scZC1AYy) and the results are located in the [Release Management repository](https://github.com/camaraproject/ReleaseManagement). -**It provides the initial version of de guidelines describing how to releasing an API version, as well as the API-Readiness-Checklist template in which to record the availability of the artefacts required for the API release.** +**It provides the initial version of de guidelines describing how to release an API version, as well as the API-Readiness-Checklist template in which to record the availability of the artefacts required for the API release.** It contains the Release Management approved documents in the **documentation** folder: - **[API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API_Release_Guidelines.md)** - An extract of the API Release Management process form the CAMARA wiki. From c331a2192c1ba6008ad25496883b35d1e44fe6b3 Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Wed, 9 Oct 2024 18:23:20 +0200 Subject: [PATCH 05/11] Applied review comments --- CHANGELOG => CHANGELOG.md | 0 VERSION.md | 1 - VERSION.yaml | 1 + 3 files changed, 1 insertion(+), 1 deletion(-) rename CHANGELOG => CHANGELOG.md (100%) delete mode 100644 VERSION.md create mode 100644 VERSION.yaml diff --git a/CHANGELOG b/CHANGELOG.md similarity index 100% rename from CHANGELOG rename to CHANGELOG.md diff --git a/VERSION.md b/VERSION.md deleted file mode 100644 index 15a9196..0000000 --- a/VERSION.md +++ /dev/null @@ -1 +0,0 @@ -version: v0.1.0 diff --git a/VERSION.yaml b/VERSION.yaml new file mode 100644 index 0000000..5593cd8 --- /dev/null +++ b/VERSION.yaml @@ -0,0 +1 @@ +version: 0.1.0 From 9c81c84ceea1a3973b1f19cc32537f2fba48adee Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Wed, 9 Oct 2024 19:09:46 +0200 Subject: [PATCH 06/11] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 486ca17..90d0d07 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ Repository to describe, develop, document and test the Release Management proces ## Release Process Information -This is the first release of the Release Management documents with version 0.1.0. +For the latest release see https://github.com/camaraproject/ReleaseManagement/releases/latest -It contains the Release Management approved documents in the **documentation** folder: +The pre-release r1.1 contains the Release Management approved documents in the **documentation** folder: - [API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API_Release_Guidelines.md) - An extract of the API Release Management process form the CAMARA wiki. - [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API-Readiness-Checklist.md) - The checklist (template to copy) to ensure release readiness of the API according to its release type (alpha, release-candidate, public). - [CHANGELOG_TEMPLATE.md (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/CHANGELOG_TEMPLATE.md) From 73747d05dd525558d4e739f850cc03b5f09dfa2b Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Wed, 9 Oct 2024 19:11:37 +0200 Subject: [PATCH 07/11] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 90d0d07..3588608 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,6 @@ The pre-release r1.1 contains the Release Management approved documents in the * - [CHANGELOG_TEMPLATE.md (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/CHANGELOG_TEMPLATE.md) - An example of the CHANGELOG created per the release management process is here: [CHANGELOG_EXAMPLE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/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) ## Release Management Wiki From 985ec9fdf1263c442d486272c3e369fc31fb77a2 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Wed, 9 Oct 2024 20:03:42 +0200 Subject: [PATCH 08/11] Update CHANGELOG.md - added r1.2 --- CHANGELOG.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41420be..ede1595 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,50 @@ ## Table of Contents +- **[r1.2](#r12)** - **[r1.1](#r11)** +# r1.2 - public release + +## Release Notes + +**This is the first public release of the Release Management documents with version v0.2.0.** + +It describes the processes and artifacts for use in the Release Management of the Fall24 meta-release. + +It contains the Release Management approved documents in the **documentation** folder: + - [API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/API_Release_Guidelines.md) - An extract of the API Release Management process from the CAMARA wiki. + - [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/API-Readiness-Checklist.md) - The checklist to ensure release readiness of the API according to its release type (alpha, release-candidate, public). + - [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/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](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) - An example of the content of and API repository's CHANGELOG.md file over various releases. + +The following are all the updates since the start of the Release Management Working Group and includes the updates for [r1.1](#r11). + +### Added +* Added API-Readiness-Checklist.md by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/29 +* Added API Release Guidelines to GitHub - extract of the API Release Process by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31 +* Added changelog template and example by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/36 and @hdamker in https://github.com/camaraproject/ReleaseManagement/pull/38 +* Created API repository release review issue template by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/45 +* Uploaded Fall24 Meta-release presentation material by @hdamker in https://github.com/camaraproject/ReleaseManagement/pull/96 + +### Changed + +* Updated public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35 +* Updated release review issue template by @tanjadegroot and @hdamker in https://github.com/camaraproject/ReleaseManagement/pull/47, https://github.com/camaraproject/ReleaseManagement/pull/50, https://github.com/camaraproject/ReleaseManagement/pull/60, and https://github.com/camaraproject/ReleaseManagement/pull/62 +* Updated README.md and further links in release management material by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/42 + +### Fixed + +* Update README.md with updated URLs to new Cloud based wiki by @wrathwolf in https://github.com/camaraproject/ReleaseManagement/pull/102 + +## New Contributors + +* @wrathwolf made their first contribution in https://github.com/camaraproject/ReleaseManagement/pull/102 + +**Full Changelog**: https://github.com/camaraproject/ReleaseManagement/commits/r1.2 + # r1.1 ## Release Notes @@ -20,12 +62,12 @@ It contains the Release Management approved documents in the **documentation** f ### Added * Add API-Readiness-Checklist.md to RM project by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/29 -* Add API Release Guidelines to GitHub - extract of the API Release Pro… by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31 +* Add API Release Guidelines to GitHub - extract of the API Release Process by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/31 * Added changelog template and example by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/36 and @hdamker in https://github.com/camaraproject/ReleaseManagement/pull/38 -* Update public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35 ### Changed -N/A + +* Updated public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35 ### Fixed N/A @@ -38,4 +80,4 @@ N/A * @MarkusKuemmerle made their first contribution in https://github.com/camaraproject/ReleaseManagement/pull/21 * @tanjadegroot made their first contribution in https://github.com/camaraproject/ReleaseManagement/pull/29 -Full Changelog: https://github.com/nokia/camaraproject-ReleaseManagement/commits/r1.1 \ No newline at end of file +Full Changelog: https://github.com/nokia/camaraproject-ReleaseManagement/commits/r1.1 From bce778a1a66e4e2ddc55cb256100902f5fb8b8e4 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Wed, 9 Oct 2024 20:19:07 +0200 Subject: [PATCH 09/11] Update README.md - update for r1.2 --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3588608..0d058ed 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,24 @@ Repository to describe, develop, document and test the Release Management proces ## Scope * Guidelines and assets for Release Management in CAMARA -* Describe, develop, document and test the deliverables +* Describe, develop, document and apply the deliverables * Started: November 2023 ## Release Process Information -For the latest release see https://github.com/camaraproject/ReleaseManagement/releases/latest +**The first public release of the Release Management documents with version v0.2.0 is availalbe in [r1.2](https://github.com/camaraproject/ReleaseManagement/releases/tag/r1.2)** -The pre-release r1.1 contains the Release Management approved documents in the **documentation** folder: - - [API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API_Release_Guidelines.md) - An extract of the API Release Management process form the CAMARA wiki. - - [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/API-Readiness-Checklist.md) - The checklist (template to copy) to ensure release readiness of the API according to its release type (alpha, release-candidate, public). - - [CHANGELOG_TEMPLATE.md (template for copying)](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/CHANGELOG_TEMPLATE.md) - - An example of the CHANGELOG created per the release management process is here: [CHANGELOG_EXAMPLE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.1/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) +It describes the processes and artifacts for use in the Release Management of the Fall24 meta-release. -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) +It contains the Release Management approved documents in the **documentation** folder: + - [API_Release_Guidelines.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/API_Release_Guidelines.md) - An extract of the API Release Management process from the CAMARA wiki. + - [API-Readiness-Checklist.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/API-Readiness-Checklist.md) - The checklist to ensure release readiness of the API according to its release type (alpha, release-candidate, public). + - [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/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](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) - An example of + +For the reference documentation on API versioning please see Chapter 5 within the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities/). ## Release Management Wiki @@ -46,10 +50,10 @@ More information about processes and release numbering for Commonalities and ICM * [Commonalities and ICM Release Process](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551399/Meta-release+Process#Commonalities-and-ICM) ## Contributing -* Meeting link: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/97762557636?password=e5f98402-8c29-448d-a8b1-f2dceaa9d4ba) -* Schedule: Weekly on Tuesday's at 08:00 PT / 16:00 UTC / 17:00 CET -* Meeting minutes are available within the [wiki of the Release Management Working Group](https://lf-camaraproject.atlassian.net/wiki/x/VA7e) - -## Contributorship and mailing list -* Subscribe / Unsubscribe to the mailing list of this Working Group . -* A message to all Contributors of this Working Group can be sent using . +* Meetings are held virtually + * Schedule: Weekly on Tuesday's at 08:00 PT / 16:00 UTC / 17:00 CET + * Meeting link: [Meeting Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/97762557636?password=e5f98402-8c29-448d-a8b1-f2dceaa9d4ba) + * Meeting minutes are available within the [wiki of the Release Management Working Group](https://lf-camaraproject.atlassian.net/wiki/x/VA7e) +* Mailing List + * Subscribe / Unsubscribe to the mailing list of this Working Group . + * A message to all Contributors of this Working Group can be sent using . From 299c335601a5a00f34d586b32e6663004e758b13 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Wed, 9 Oct 2024 20:19:24 +0200 Subject: [PATCH 10/11] Update VERSION.yaml --- VERSION.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VERSION.yaml b/VERSION.yaml index 5593cd8..1726e2d 100644 --- a/VERSION.yaml +++ b/VERSION.yaml @@ -1 +1 @@ -version: 0.1.0 +version: 0.2.0 From eb8edb9adedb8790e6a3fa0bf1d24fc9620653b1 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 10 Oct 2024 07:47:28 +0200 Subject: [PATCH 11/11] Update README.md Co-authored-by: tanjadegroot <87864067+tanjadegroot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d058ed..4d207dc 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ It contains the Release Management approved documents in the **documentation** f - [CHANGELOG_TEMPLATE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/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](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) - An example of + - [CHANGELOG_EXAMPLE.md](https://github.com/camaraproject/ReleaseManagement/blob/r1.2/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) - An example of the content of a CHANGELOG.md over multiple releases created following the Release Management guidelines. For the reference documentation on API versioning please see Chapter 5 within the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities/).