mikepenz / release-changelog-builder-action

A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want.
https://blog.mikepenz.dev
Apache License 2.0
716 stars 103 forks source link

body: - no changes ? #413

Closed vvatelot closed 3 years ago

vvatelot commented 3 years ago

Hello @mikepenz I maybe have a misconfiguration and I am trying to figure out how to make your github action work. So, sorry if this issue is not completely relevant...

I used the example you provide in the readme and I make PR on my project:

When I add a tag, the action works fine, but it results with a no changes body... Did I miss something ? image

mikepenz commented 3 years ago

Hey @vvatelot

The action by default uses the merged PRs to generate the changelog for. Those PRs are categorized via their label.

According to your log it had 2 PRs it kept, but those were not categorized so it would not inlclude them in the default template.

Screenshot 2021-07-29 at 16 09 36

You can include uncategorized PRs in your changelog too if you like

vvatelot commented 3 years ago

Alright! I read your documentation and things are clear now:

Thanks again @mikepenz for this great tool and your help :+1:

mikepenz commented 3 years ago

@vvatelot glad I was able to help.

Please let me know if there's something we can improve in the docs, to help others.

Thank you very much

vvatelot commented 3 years ago

The things that confused me is that I used the full sample and assumed that everything would work out of the box. But I needed to use tags and then add a config file to make the mapping of the tags / categories. So maybe just explain this? :thinking:

mikepenz commented 3 years ago

Good point, will add a note to the full sample that the PRs are required to be labelled with one of the default labels to show up, otherwise custom configuration will be needed.

Thank you very much.