github-tools / github-tools/github-release-notes

documentation not clear how to use milestones

Open
#285 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
JavaScript
Stars
897
Forks
313
PR merge metrics
No merged PRs in 30d

Description

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!

Contributor guide

Open the contributing guide

Research direction

Review the configuration entry for milestoneMatch against the referenced “Milestone 1.0.0” milestone and the v1.0.0 tag. Determine which placeholder form the project expects, then clarify the documentation with a working example and verify it against release-note generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript
Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.