diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..41420be --- /dev/null +++ b/CHANGELOG.md @@ -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 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 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 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. 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