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

Changelog output mode #60

Open
Tracked by #61
epage opened this issue Aug 9, 2022 · 2 comments
Open
Tracked by #61

Changelog output mode #60

epage opened this issue Aug 9, 2022 · 2 comments
Labels
A-cli Area: engine around the lints C-enhancement Category: raise the bar on expectations

Comments

@epage
Copy link
Collaborator

epage commented Aug 9, 2022

Like #6 being an output mode, this would be another that would provide a snippet for including in a changelog. No-touch additions (automatically insert into file, using a particular users format, etc) are non-goals. The focus is on a starting point as the user will likely want to add more information as well and we want to encourage users to do so rather than it being "good enough".

The hope is this will encourage people to write changelogs more.

@epage epage added A-cli Area: engine around the lints C-enhancement Category: raise the bar on expectations labels Aug 9, 2022
@epage
Copy link
Collaborator Author

epage commented Aug 9, 2022

Likely blocked on #58

@obi1kenobi
Copy link
Owner

Here's a specific use case for this mode: kenba/opencl3#54

That PR shows that an API change that happened across a major version was unintentional and undesirable: some items of a glob re-export were shadowed by a local use statement of other items, and as a result stopped being part of the public API of the crate. This was semver-compliant since the change happened across a major version boundary.

A changelog output mode, perhaps one where the action posts a GitHub comment with the changelog, could have prevented this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-cli Area: engine around the lints C-enhancement Category: raise the bar on expectations
Projects
None yet
Development

No branches or pull requests

2 participants