search

conventional-changelog / standard-version

:trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
ISC License
7.68k stars 792 forks source link

Changelog link to another repo in same organisation #492

Open 40in opened 4 years ago

40in commented 4 years ago

Given circumstances:

repos: https://github.com/awesome-corp/santa-claus/ https://github.com/awesome-corp/santa-mouse/

Issue was logged in santa-claus repo. And closed with such PR in santa-mouse repo:

feat(button): add new awesome button awesome-corp/santa-claus#999

standard-version will generate such line:

So the actual link will be pointing to wrong repo.

jbottigliero commented 4 years ago

Hi @40in,

Some time has passed since you posted this... but I wanted to follow-up and see if you're still having issues. I'm currently using the latest standard-version (7.1.0) and have similar setups across our org.

A few things... for the conventional-changelog stack to work best, you should follow the Conventional Commits spec. While referencing an issue in the title might work in some contexts... it won't be as well supported as a reference in the [optional footer(s)] section.

Additionally, when using the convention, make sure you're using the GitHub cross-repository reference, not just the issue number (unless the issue is local to the repository you are commiting to).

ie.

feat(Button): Adds a new button to the interface in santa-mouse.
- Adds the new awesome button, but actually links to an issue in another repository (santa-claus)

awesome-corp/santa-claus#999

If you have a repository local issue and cross-repository issue you need to reference, you can separate with a ,:

feat(Button): Adds a new button to the interface in santa-mouse.
- Adds the new awesome button, but actually links to an issue in another repository (santa-claus) AND one in this repository (number ten).

awesome-corp/santa-claus#999, #10