Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
tony opened this issue Oct 13, 2024 · 1 comment
Open

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

tony opened this issue Oct 13, 2024 · 1 comment

Comments

@tony
Copy link

tony commented Oct 13, 2024

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.

Copy link
Contributor

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 30 days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants