search

github-tools / github-release-notes

Node module to create a release or a changelog from a tag and uses issues or commits to creating the release notes.
https://github-tools.github.io/github-release-notes/
GNU General Public License v3.0
880 stars 325 forks source link

documentation not clear how to use milestones #285

Open tillias opened 3 years ago

tillias commented 3 years ago

Hello folks,

I have following milestone: "Milestone 1.0.0" or here: https://github.com/tillias/microservice-catalog/milestone/1

I have this tag: "v1.0.0": https://github.com/tillias/microservice-catalog/tree/v1.0.0

Is this correct usage in config file: "milestoneMatch": "(Milestone {{tag_name}})"

Or should I use "milestoneMatch": "(Milestone v{{tag_name}})"

Or should I use "milestoneMatch": "(Milestone {{vtag_name}})"

Many thanks!

alexcanessa commented 3 years ago

Hello @tillias so since your tag contains a v and your milestone doesn't it's a bit more complicated.

If you rename your milestone to "Milestone v1.0.0" then your match is "Milestone {{tag_name}}"