search

catalyst / catalyst-moodle-workflows

4 stars 7 forks source link

Auto-generate nice looking changelog. #82

Open danmarsden opened 1 year ago

danmarsden commented 1 year ago

Something that's come up recently in the MUA forums is that some people really like to be able to see a nice readable changelog for plugins - we don't do this for most of our plugins and instead point people at the commit history..

But - I see there's some nice github action templates where people have used github actions to generate a changelog eg: https://github.com/marketplace/actions/release-changelog-builder

would be nice to build this into our workflows to auto-build a changelog file based on the commit messages between version bumps.

I don't have any plans/time to work on this, but wanted to record it here because it seems like a sensible thing we could do that would add a decent value to our plugins.

keevan commented 1 year ago

I have always wanted this as well. Not looking into it in detail yet, wouldn't this require a more set-in-stone commit message format to be applied?

Skimming the github action, this might be using labels instead / in-addition?

Note: PRs will only show up in the changelog if assigned one of the default label categories "feature", "fix" or "test"