ratchet icon indicating copy to clipboard operation
ratchet copied to clipboard

when doing an update - also have the ability to generate a git short log for each ci component

Open kapilt opened this issue 3 years ago • 1 comments

TL;DR

when pinning stuff we always have to update eventually, for bug fixes, features, security. but auditing those updates is also a key aspect, one simple facility that would make that nicer is for ratchet to generate a changelog.md on the updates (via git checkout and short log on the delta between the two revisions), which can then be used in a pull request description/comment to help reviewers on the updates.

Detailed design

No response

Additional information

No response

kapilt avatar May 25 '22 13:05 kapilt

Hi @kapilt

Unfortunately we can't easily do that for two reasons:

  1. If a ref is pinned to a floating tag (like main), the delta isn't meaningful.

  2. No such "diff" exists for containers.

I think we could print out a summary at the end of the original -> updated values, but I don't think it'd be useful to construct diffs, since that will be highly platform dependent (and Ratchet will likely expand to support multiple CI/CD workflow systems).

sethvargo avatar May 25 '22 14:05 sethvargo

I think I that's fair and in practice, using ratchet, with dependbot updates on actions does generate the needed context on accepting updates re changelogs as well automating the cron/update aspect.

kapilt avatar Oct 10 '22 18:10 kapilt