You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generate release notes using the default changelog path from a commit subject that contains an inline-code mention-like token, for example:
- feat: add `@spawn` macro
- fix: bug in `@unsafe` macro
Inspect the generated markdown output.
Actual behavior:
mention-like text inside inline code spans is rewritten into a GitHub user link, e.g.
`[@spawn](https://github.com/spawn)`
`[@unsafe](https://github.com/unsafe)`
Expected behavior:
mention-like text inside inline code spans should remain literal inline code:
`@spawn`
`@unsafe`
Notes:
This seems to come from the default changelog generation stack used by release-please via conventional-changelog-conventionalcommits.
In conventional-changelog-conventionalcommits/writer-opts.js, the subject transform rewrites @user to [@user](...) without distinguishing plain text from inline-code content.
release-please already preserves inline code specially for < / > escaping in src/changelog-notes/default.ts, so it seems reasonable to also preserve inline-code @... literally.
Environment details
release-pleaseversion: 17.3.0Steps to reproduce
Generate release notes using the default changelog path from a commit subject that contains an inline-code mention-like token, for example:
-
feat: add `@spawn` macro-
fix: bug in `@unsafe` macroInspect the generated markdown output.
Actual behavior:
`[@spawn](https://github.com/spawn)``[@unsafe](https://github.com/unsafe)`Expected behavior:
`@spawn``@unsafe`Notes:
release-pleaseviaconventional-changelog-conventionalcommits.conventional-changelog-conventionalcommits/writer-opts.js, the subject transform rewrites@userto[@user](...)without distinguishing plain text from inline-code content.release-pleasealready preserves inline code specially for</>escaping insrc/changelog-notes/default.ts, so it seems reasonable to also preserve inline-code@...literally.cc @MilesCranmer