Skip to content

Make release notifications useful againΒ #430

@jrfnl

Description

@jrfnl

@peter-evans Thank you for this action and the other actions you maintain!

I'd just like to make a small suggestion regarding the release notifications - while I totally understand that auto-generating those saves maintainer time, it also means the release notifications as they are now, are next to useless and wastes maintainer time on the other side.

It is my firm believe that changelogs are for humans and all CI/test/doc updates which do not impact end-users should just be grouped under a single "Various housekeeping, including improvements to the tests and documentation." entry in a changelog.

If, and only if, a dependabot update is relevant for end-users, it can be mentioned in the changelog, but only with a single entry per dependency.

Example from the 4.0.0 release (and I'm not even sure this one is relevant for end-users):
Instead of having 56(!!) "build(deps-dev): bump @types/node from x.x.x to x.x.x by https://github.com/dependabot[bot] in #..." entries in the release notification, one would have sufficed and would have made the release notification infinitely more readable:

Even grouping the changelog entries into the typical semver "Added'/"Changed"/"Removed"/"Fixed"/"Maintenance" categories (where everything in "maintenance" can be ignored by non-contributors) would already help.

The problem with the release notifications as they are now, is that it takes every single person trying to find out what has changed at least five minutes to figure out what the relevant changes are, which is five minutes wasted per project depending on this action (and others).

Case in point: I'm currently trying to figure what has changed in the 4.0.0 release to make my CI builds fail with a "Error: Parameter token or opts.auth is required" error, but am struggling to find the relevant change entry.

I hope you'll at least consider my request, but respect your decision either way.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions