search

pre-commit-ci / issues

public issues for https://pre-commit.ci
17 stars 3 forks source link

Add links to changelogs in autoupdater pull requests. #32

Closed domdfcoding closed 3 years ago

domdfcoding commented 3 years ago

If the hook repository provides a CHANGELOG.md file, it would be handy if a link to it could be provided in the pull request body.

For instance, for pre-commit/pre-commit-hooks the link would be https://github.com/pre-commit/pre-commit-hooks/blob/master/CHANGELOG.md

bastienboutonnet commented 3 years ago

I was just going to suggest that. Would be super nice if that was possible indeed.

asottile commented 3 years ago

repositories are treated opaquely (autoupdate doesn't know what vcs service it is, doesn't know what it was before, etc.) and changelogs are conventional-at-best (you don't really know where they are, it could be CHANGELOG.md, it could be the releases tab, it could be docs/changes.rst, etc. etc.)

I don't think this is doable in the general case, and will necessarily introduce more api calls which makes this more expensive to run -- what are your thoughts?

bastienboutonnet commented 3 years ago

Yeah it's definitely not straightforward... I wonder how apps like dependabot do it. Sometimes they provide info sometimes they don't and I think they just say if they can't get any info.

I would say maybe it's "cute" to at least populate the PR description with some message. It always "shocks" me a bit that there is no lovely message in the description 🐻

But yeah other than looking into how dependabot does it I wouldn't have any suggestions and if it's a pain in the ass because it adds complication maybe there is no rush.

Just thinking that maybe when people do use it in the enterprise offering they might "demand" some PR info of at least what was changed but you're the judge of where you want to put the limits.

janosh commented 3 years ago

I would say maybe it's "cute" to at least populate the PR description with some message. It always "shocks" me a bit that there is no lovely message in the description 🐻

Was about to suggest that in a new issue. Just a quick overview of changes would make sense:

isort 5.7.0 -> 5.8.0
flake8 2.10.0 -> 2.11.0
asottile commented 3 years ago

this is now implemented -- the next autoupdate you get will look something like this:

updates:

janosh commented 3 years ago

Good stuff!