Skip to content

[DOCS]: Release notes are very noisy and inconsistent #1506

@pndurette

Description

@pndurette

Describe the need

This is more of required changes to the release process but it affects documentation and usability:

The release notes (changelog) are very noisy, which makes it difficult to single out important functional changes (for example, at a glance from a Dependabot PR on a repo). The important features and bugfixes are lost in a sea of .md files updates, GitHub Actions workflow changes and Dependabot updates the often doesn't impact the end-user.

Might I suggest adopting something like Conventional Commits or anything similar to categorize the changes in release notes instead of a general "What's Changed"? (e.g. with Conventional Commits, updating the GitHub Actions workflows would be a chore which wouldn't even appear in release notes, same for Dependabot updates, which I see is already committing in CC).

SDK Version

N/A

API Version

N/A

Relevant log output

N/A

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: DocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    ✅ Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions