Skip to content

Releases: Most accessible way to track changelog across releases? #2872

Open
@tony

Description

@tony

Describe the question

Thanks for the project!

I'm currently a bit behind on updates (almost a year) and want to bump the version. Since in this case, there's been a delay, quite a few releases have happened since.

Ideally, I would like to link a git commit showing the changes across multiple releases.

What’s the best approach for users to catch up and understand what's changed?

A single-file changelog would typically make this easier (example: opentelemetry-collector's CHANGELOG.md). Does one exist?

Steps to reproduce if your question is related to an action

What did you expect to see?
A single, well-maintained changelog where users can easily scroll through all changes without extra distractions (downloads, pagination, padding, etc.).

Examples in aws-observability:

Environment
Purely developer experience / user experience related, and it may be a niche (I don't see it mentioned elsewhere). If I'm making a mistake please let me know!

Additional context:
Out of respect for the maintainers and contributors time, I imagine there are established patterns and good reasons why a single changelog might not exist. I definitely don't want to cause any disruption if this is a unique concern on my part! 😄

To be clear, I'm speaking of "changes of note" that maintainers wish to show in the changelog, not commits themselves, e.g. not these: v0.18.0...v0.19.0.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions