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

Feature: Add a summary of relevant changes to releases or to a CHANGELOG file #2784

Closed
pnacht opened this issue Mar 23, 2023 · 3 comments
Closed
Labels
kind/enhancement New feature or request

Comments

@pnacht
Copy link
Contributor

pnacht commented Mar 23, 2023

Is your feature request related to a problem? Please describe.
As a user of Scorecard, it's hard to know whether to update to a new version. Releases only show a wall of commits, most of which aren't "interesting" and some of which aren't understandable at a glance (i.e. "Atomically load from accessState to avoid data race."), meaning I need to open the PR to understand if it's something I care about.

Describe the solution you'd like
All releases would start with a summary of significant changes, so that a user can tell at a glance whether the changes are relevant to their use-case. The summary would include anything maintainers deem significant, which would include anything with any chance of modifying a project's score.

The example below was my best effort to detect relevant changes in 4.10.4 by looking at the changelog, which took me a (many) few minutes. It'd be great if someone more in-the-know could do this once, instead of all users having to do it for themselves, with a higher chance of missing something (maybe I did in the example below!).

Additional context
I've noticed that PRs have a section that's meant to be used for release-note, but it doesn't seem to be used.


v4.10.4

Notable changes

Changelog

9831629 Increase recordings, switch API, and lower tolerance (#2760)
8966abd Initial implementation of go-git client (#2720)
[...]

@pnacht pnacht added the kind/enhancement New feature or request label Mar 23, 2023
@spencerschrock
Copy link
Member

Sorry in advance for a possible (but smaller) wall of commits for a v4.10.5

This has been discussed a bit in #982 and #1677 (which I just added a comment to). release-note isn't something goreleaser does, but it may be possible to combine the k8s release-notes util with it after the fact.

goreleaser does support some customization, which I assume we can use in the action as well, which would let us ignore certain categories, highlight others, etc. Which would hopefully highlight ✨ features and ignore some of the dependabot bump updates

@github-actions
Copy link

Stale issue message - this issue will be closed in 7 days

@spencerschrock
Copy link
Member

Completed via #3322

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants