r4.1

Release Management r4.1 baseline for Sync26

r4.1 is the public release of the Release Management documents with repository
version 0.5.0.

The release consolidates the automated API release process documentation,
metadata schema artifacts, release progress tracking data, and validation
framework design material that landed after r3.1. It provides the Release
Management repository baseline for API teams preparing Sync26 releases and for
the continued evolution of the r4.x release process.

Key Updates

• Automated release process: release creation, review, publication,
  post-release sync, bot UX, and branch terminology documentation.
• Release metadata: release plan and release metadata schema artifacts with
  examples for API repositories.
• API readiness: updated checklist guidance for validation results, warning
  deferrals, and API description requirements.
• Validation framework reference material: requirements, detailed design,
  design-guide audit, testing-guidelines audit, and Commonalities consumption
  design documents.
• Release progress tracking: repository progress tracker workflow and
  generated progress data.
• Sync26 terminology: updated references from Fall26/Spring27 to
  Sync26/Signal27 where applicable.

Changes since r3.1

Added

• Add the release workflow and metadata foundation, including concept material, release metadata schemas, and release plan schema artifacts by @hdamker in #275 and #339
• Add the automated release process documentation set, covering release creation, release publication, post-release sync, bot UX, API readiness checklist content, and pointer branch documentation by @hdamker in #362, #364, #370, #374, #392, and #394
• Add validation framework reference material, including Commonalities consumption and bundling design, requirements, detailed design, design-guide audit, and testing-guidelines audit by @hdamker in #436, #447, and #463
• Add release progress tracker workflow and generated progress data by @hdamker in #391
• Add the automated release process update presentation by @tanjadegroot in #424

Changed

• Refine release lifecycle and readiness documentation for the edit/review split, post-release sync step, CHANGELOG handling, breaking changes handling, validation results, warning deferrals, and API description requirements by @hdamker and @tanjadegroot in #523, #569, and #586
• Update README content for the current Release Management documentation structure by @tanjadegroot in #460
• Align naming and branch terminology with Sync26/Signal27, source branch terminology, and release branch naming by @hdamker in #382, #384, #386, and #402
• Maintain release progress tracker data through Release Collector bot updates

Removed

• Remove the unused API review trigger workflow by @hdamker in #488

Full Changelog: r3.1...r4.1

r3.1

Release Notes

This release captures the Release Management documents as used in the Fall25 meta-release.
This release includes updates to the API release process documentation, introduction of automated API review workflows, and enhancements to the API readiness checklist. This release provides a reference point before preparing the Spring26 meta-release.

Added

• Add API description requirement to API-Readiness-Checklist by @tanjadegroot in #209
• Add Sandbox related information to API Release Guidelines by @tanjadegroot in #219
• Create api-review-trigger workflow for automated API compliance reviews by @hdamker in #270

Changed

• Update API-Readiness-Checklist with API description requirement and clarify API documentation field by @tanjadegroot and @hdamker in #209
• Update API Release Guidelines to include Sandbox teams participation in meta-releases by @tanjadegroot in #219
• Update CHANGELOG template to use camaraproject swagger-ui instead of editor.swagger.io in #230
• Update Fall25 M3 review issue template by @rartych in #222

Full Changelog: r2.2...r3.1

r2.2

Release Notes

This is the public release of the Release Management documents for use in the Spring25 meta-release with version v0.3.0.

It describes the processesand 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 #118
• Updates to API readiness checklist by @tanjadegroot in #116
• Update changelog template & example by @tanjadegroot in #117

Full Changelog: r1.2...r2.2

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 #118
• updates to API readiness checklist by @tanjadegroot in #116
• Update changelog template & example by @tanjadegroot in #117

Full Changelog: r1.2...r2.1

r1.2

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 - An extract of the API Release Management process from the CAMARA wiki.
• 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 - The template for creating CHANGELOG history of an API repository.

It also contains the following in the documentation/SupportingDocuments folder:

• 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.

Added

• Added API-Readiness-Checklist.md by @tanjadegroot in #29
• Added API Release Guidelines to GitHub - extract of the API Release Process by @tanjadegroot in #31
• Added changelog template and example by @tanjadegroot in #36 and @hdamker in #38
• Created API repository release review issue template by @tanjadegroot in #45
• Uploaded Fall24 Meta-release presentation material by @hdamker in #96

Changed

• Updated public release name by @tanjadegroot in #35
• Updated release review issue template by @tanjadegroot and @hdamker in #47, #50, #60, and #62
• Updated README.md and further links in release management material by @tanjadegroot in #42

Fixed

• Update README.md with updated URLs to new Cloud based wiki by @wrathwolf in #102

New Contributors

• @hdamker made their first contribution in #8
• @MarkusKuemmerle made their first contribution in #21
• @tanjadegroot made their first contribution in #29
• @wrathwolf made their first contribution in #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 and the results are located in the Release Management repository.

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 - An extract of the API Release Management process form the CAMARA wiki.
• 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 #29
• Add API Release Guidelines to GitHub - extract of the API Release Pro… by @tanjadegroot in #31
• Added changelog template and example by @tanjadegroot in #36 and @hdamker in #38
• Update public release name by @tanjadegroot in #35

Changed

N/A

Fixed

N/A

Removed

N/A

New Contributors

• @hdamker made their first contribution in #8
• @MarkusKuemmerle made their first contribution in #21
• @tanjadegroot made their first contribution in #29

Full Changelog: https://github.com/nokia/camaraproject-ReleaseManagement/commits/r1.1