semantic-release / semantic-release/release-notes-generator
tagFormat not respected in markdown headings during changelog generation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 368
- Forks
- 55
- Avg merge
- 10m
- Merged PRs (30d)
- 1
Description
I'm not sure if this is the correct place to ask this question but it seems like the tagFormat value from .releaserc is not followed when generating the actual changelog.
For example, my tagFormat is tagFormat: "1.5.6-${version}"
However, the changelog creates headings like ## [1.0.0-develop.2](https://my.gitlab.repo.com/ctek/docker/packer/compare/1.5.6-1.0.0-develop.1...1.5.6-1.0.0-develop.2) (2020-05-04)
Note that the compare links are correct but the heading is not.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named. Start by tracing changelog generation from the .releaserc tagFormat setting, compare the heading value with the correctly formatted compare links, and reproduce the example using the shown 1.5.6-${version} format. Done means generated markdown headings use the configured tag format consistently with their links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- release
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100