search

alexellis / derek

Reduce maintainer fatigue by automating GitHub
https://github.com/alexellis/derek/blob/master/USER_GUIDE.md
MIT License
808 stars 70 forks source link

Have Derek show a link for changes between releases on auto-generated release notes. #178

Closed alexellis closed 2 years ago

alexellis commented 3 years ago

Have Derek show a link for changes between releases on auto-generated notes.

Expected Behaviour

GitHub has a syntax to show a diff of changes between releases, something like adding v1.0.0...v2.0.0 to the URL, the format would be: https://github.com/alexellis/derek/compare/0.10.9...0.11.0

Current Behaviour

Here's how it looks today: https://github.com/alexellis/derek/releases/tag/0.11.0

We don't provide this URL at the moment.

Screenshot from 2021-09-09 10-36-26

Possible Solution

Let's add this text to each generated commit message, since we know the previous release already. And when we have no prior release, perhaps we can compare to the first commit of the release?

Steps to Reproduce (for bugs)

  1. Add Derek to your repo
  2. Create a few commits
  3. Create a release and see the auto-generated summary

Context

OpenFaaS users could really use this kind of addition. One in particular asked for it recently.

alexellis commented 3 years ago

/add label: help wanted, good first issue

cpanato commented 3 years ago

/assign

alexellis commented 3 years ago

Thanks for picking this up @cpanato

Testing on a public cloud VM will be helpful here, or using inlets so that you can receive webhooks and test this end to end.

Setting up the GitHub app is a bit time consuming the first time, but I've tried to make it as simple as possible in the notes.