Comments (3)
I'm not able to reproduce this -
mkdir example
cd example
touch readme.md
git add readme.md
git commit -m "feat: example <with tag>"
npx commit-and-tag-version
generates a changelog with:
## 1.1.0 (2024-01-15)
### Features
* example <with tag> dfa9580
As an aside, I think having markdown syntax in commit messages is actually helpful - as it lets you format code (useful for the tag syntax):
# note the single quotes
git commit -m 'feat: example `<with tag>`'
from commit-and-tag-version.
Yea, the generated changelog is correct. But the <
& >
characters will be parsed and won't shown in the output.
Also, I agree that having markdown syntax in the commit message is helpful, But I think it will be awesome if we can have an option to parse or escape it.
from commit-and-tag-version.
Ah, I see what you're getting at.
...characters will be parsed
Am I right in understanding that the issue is that they're parsed by markdown, because they weren't escaped at the time the markdown file is written?
I think escaping the characters that markdown interprets would be a bit unexpected, so this doesn't feel like a bug to me. But, I see how it might be useful to be able to do this with a config option.
This project is intended to be a wrapper around conventional-changelog. Conventional-changelog controls the writing of the changelog, and I think the package that knows how to write markdown is conventional-changelog-writer (although I'm not certain). You might want to open an issue / PR over there.
from commit-and-tag-version.
Related Issues (20)
- Multiple postchangelog scripts? HOT 1
- Bug: Frontmatter is duplicated in certain scenarios HOT 7
- Cannot run tests using Node 20 HOT 11
- Does this package not support setting --header?
- Use without pushing directly to master/main? HOT 2
- Include all commits in CHANGELOG
- Why did `npx commit-and-tag-version` miss the most recent commit? HOT 2
- Argument `--releaseAs [1.1.0]` is ignored if `--skip.bump` is also used
- Reverted commits are included in the generated CHANGELOG.md
- Why commits got repeated when I format the CHANGELOG file manually? HOT 5
- Bump files, which are being ignored in Git, too HOT 1
- Compare releases agains previous release (skipping prerelease) HOT 3
- How can I generate a CHANGELOG.md based on a different commit convention? HOT 3
- Commits got repeated when I format the CHANGELOG file manually? (revamp #133)
- Support ESM format for config file HOT 3
- Make it more obvious that some/all config options can be set via separate config
- Show changelog only for changes in a subfolder HOT 2
- How to access the release type in life cycle scripts?
- Allow passing additional arguments to git-semver-tags HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from commit-and-tag-version.