Merge branch 'camaraproject:main' into 99-updates-per-feedback

CHANGELOG.md

@@ -0,0 +1,83 @@
+# Changelog Release Management
+
+## 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
+
+**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 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.
+   - **[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 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
+
+### Changed
+
+* Updated public release name by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/35
+
+### 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

README.md

@@ -11,21 +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
-* First release: r1.0.0 (July 2024)
 
 ## Release Process Information
 
-This projects contains the following documentation:
+**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)**
 
-* [API Release Guidelines](/documentation/API_Release_Guidelines.md)
-* [API Readiness Checklist (template for copying)](/documentation/API-Readiness-Checklist.md)
-* [CHANGELOG (template for copying)](/documentation/CHANGELOG_TEMPLATE.md)
+It describes the processes and artifacts for use in the Release Management of the Fall24 meta-release.
 
-An example of the CHANGELOG created per the release management process is here: [CHANGELOG EXAMPLE](/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.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.
 
-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 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 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/).
 
 ## Release Management Wiki
 
@@ -47,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 <https://lists.camaraproject.org/g/wg-release-management>.
-* A message to all Contributors of this Working Group can be sent using <wg-release-management@lists.camaraproject.org>.
+* 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 <https://lists.camaraproject.org/g/wg-release-management>.
+  * A message to all Contributors of this Working Group can be sent using <wg-release-management@lists.camaraproject.org>.

VERSION.yaml

@@ -0,0 +1 @@
+version: 0.2.0