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 1/5] 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 2/5] 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 3/5] 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 4/5] 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 5/5] 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