Skip to content

Feature: Implement systematic release tags and open-source formatted release notes #23

@amgowda-oci

Description

@amgowda-oci

Summary

Introduce a systematic approach for release tags and associated release notes in the repository. The release notes should follow open-source standards, documenting new features added, bugs fixed, regressions identified, and other relevant changes for each release.

Requirements

  • Establish a consistent naming convention for release tags (e.g., semantic versioning).
  • Automate or document the process for creating release tags and generating release notes.
  • Release notes must include:
    • New features added
    • Bugs fixed
    • Any regressions or breaking changes
    • Other significant updates
  • Adopt a release notes format that aligns with common open-source practices (e.g., changelog.md style, GitHub releases, etc.).
  • Update documentation to describe the release process and where notes can be found.

Acceptance Criteria

  • Each release is tagged systematically and accompanied by a release note.
  • Release notes document features, fixes, regressions, and changes in an open-source friendly format.
  • Documentation is updated to describe the tagging and release note process.

Labels: enhancement, documentation
Issue Type: Feature

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions