Skip to content

Commit

Permalink
Merge pull request #121 from nokia/r2.1-of-Release-Managament-assets-…
Browse files Browse the repository at this point in the history
…(version-0.3.0-rc.1)

r2.1 of release management repository (version 0.3.0-rc.1)
  • Loading branch information
tanjadegroot authored Nov 19, 2024
2 parents 666ac06 + c05500e commit c515a23
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 11 deletions.
19 changes: 18 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,27 @@

## Table of Contents

- **[r2.1](#r21)**
- **[r1.2](#r12)**
- **[r1.1](#r11)**

# r1.2 - public release
# r2.1

## Release Notes

**This is the pre-release of the Release Management documents for use in the Spring25 meta-release with version v0.3.0-rc.1.**

It describes the processes and artifacts for use in the Release Management of the Spring25 meta-release. It includes the feedback from the Fall24 meta-release.

### Changed
* update api release guidelines by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/118
* updates to API readiness checklist by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/116
* Update changelog template & example by @tanjadegroot in https://github.com/camaraproject/ReleaseManagement/pull/117

**Full Changelog**: https://github.com/camaraproject/ReleaseManagement/compare/r1.2...r2.1


# r1.2

## Release Notes

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ Repository to describe, develop, document and test the Release Management proces

## Release Process Information

**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 Release Management documents describes the processes and the repository provides the artifacts for use by API Sub projects to release an API version.**

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 contains the Release Management released documents and assests in the **documentation** folder:
- [API_Release_Guidelines.md](/documentation/API_Release_Guidelines.md) - An extract of the API release management process from the CAMARA wiki.
- [API-Readiness-Checklist.md](/documentation/API-Readiness-Checklist.md) - The checklist to ensure release readiness of the API according to its version (alpha, release-candidate, public).
- [CHANGELOG_TEMPLATE.md](/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 a CHANGELOG.md over multiple releases created following the Release Management guidelines.
- [CHANGELOG_EXAMPLE.md](/documentation/SupportingDocuments/CHANGELOG_EXAMPLE.md) - Pointers to example CHANGELOG.md files over multiple releases created following the release management guidelines.

For the reference documentation on API versioning, please see Chapter 5 in the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities).

For the reference documentation on API versioning please see Chapter 5 within the API Design Guidelines document in [Commonalities](https://github.com/camaraproject/Commonalities/).
The [CHANGELOG.md](/CHANGELOG.md) file describes the differences between releases of the Release Management repository.

## Release Management Wiki

Expand Down
2 changes: 1 addition & 1 deletion VERSION.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version: 0.2.0
version: 0.3.0-rc.1

0 comments on commit c515a23

Please sign in to comment.