conventional-changelog/conventional-changelog

Links in CHANGELOG.md files are broken when using conventional commits

Open

#357 opened on 2018年8月6日

GitHub で見る
 (3 comments) (9 reactions) (0 assignees)JavaScript (722 forks)batch import
defecthelp wanted

Repository metrics

Stars
 (7,282 stars)
PR merge metrics
 (平均マージ 3m) (30d で 1 merged PR)

説明

I am using conventional-changelog-core through lerna and noticed that links in my CHANGELOG.md files are broken when releasing packages with lerna publish.

Context

At Wire we have a monorepo that we manage with lerna. In our monorepo there are several packages within a folder called "packages". To release all packages we run the following command:

lerna publish -m "[skip ci] chore: Publish" --conventional-commits --loglevel=verbose --exact --allow-branch=master --registry=https://registry.npmjs.org/ --yes

The command above creates a release version for every package and adds CHANGELOG.md files to the directories of the individual packages. Unfortunately all the links in that CHANGELOG are broken because they include "tree/master/packages/package-name".

Live Example:

Broken Links:

https://github.com/wireapp/wire-web-packages/tree/master/packages/react-ui-kit/compare/@wireapp/react-ui-kit@2.1.3...@wireapp/react-ui-kit@2.2.0
https://github.com/wireapp/wire-web-packages/tree/master/packages/react-ui-kit/issues/936
https://github.com/wireapp/wire-web-packages/tree/master/packages/react-ui-kit/commit/def55c0

Correct Links:

https://github.com/wireapp/wire-web-packages/compare/@wireapp/react-ui-kit@2.1.3...@wireapp/react-ui-kit@2.2.0
https://github.com/wireapp/wire-web-packages/issues/936
https://github.com/wireapp/wire-web-packages/commit/def55c0

I flagged that issue to lerna but the team says that they are just passing arguments to conventional-changelog-core. So is this a "conventional-changelog" error?

コントリビューターガイド