support CHANGELOG generating hook

[kazupon]

Is your feature request related to a problem? Please describe.
In shipjs, CHANGELOG is generated with conventional-changelog-cli.
CHANGELOG generation can be customized by setting conventionalChangelogArgs.

However, if CHANGELOG can be generated by another way than conventional-changelog-cli, it may be convenient to use other tools (e.g. lerna-changelog).

Describe the solution you'd like

module.exports = {
  generateChangelog: ({ config }) => {
    // something to do ...
  }
}

Additional context
PR-based changelog generator
https://github.com/lerna/lerna-changelog

[eunjae-lee]

@kazupon Hi there,
Thanks for your suggestion.
I will definitely take a look at lerna-changelog since it properly supports monorepos.
In the meantime, you can do a workaround like this:

export default {
  updateChangelog: false,
  beforeCommitChanges: ({ exec, dir }) => {
    exec(`npx lerna-changelog ....`);
  }
}

[kazupon]

@eunjae-lee
Thank you for your workaround!

I've checked shipjs codes and behavior.
I hope nextVersion argument of beforeCommitChanges, because it's convenient as meta info with changelog generator.

And also, I've noticed the changelog generator have some different format.
e.g.

• lerna-changelog: https://raw.githubusercontent.com/lerna/lerna-changelog/master/CHANGELOG.md
• converntional-changelog: https://raw.githubusercontent.com/algolia/shipjs/master/CHANGELOG.md

So, In GitHub release of shipjs trigger, I need changelog extraction hook.
In this code, changelog is extracted by getChangelog.
I hope it can be customized with the getChangelog hook.

[eunjae-lee]

Hi @kazupon ,
thanks for the detailed explanation.
I do agree with the points.
I will work on it and let you know how it goes.

Thanks 😄

[kazupon]

Thanks! I’ll try later 💪

[eunjae-lee]

@kazupon I took a little different approach. I just changed getChangelog to work well with both conventional-changelog and lerna-changelog :)