conventional-changelog-archived-repos/conventional-changelog-writer

deprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo

conventional-changelog-writer's Issues

Replace some options with a transform function

replace

hashLength
maxSubjectLength
map

cli has the same bug as https://github.com/ajoslin/conventional-changelog/issues/96

conventional-changelog/conventional-changelog#96

h2 for pre release?

now, only patches have h2 as header size, but in common cases it better to use h2 for pre releases

fix https://github.com/stevemao/conventional-commits-writer/blob/master/lib/util.js#L147-L150

this only works if options.generateOn is 'version'

doFlush logic is wrong. It should depend on `options.reverse`

Specifying a custom commit template breaks transformation

When a custom commit template is read in, even if it's identical to the default template, the commit subject is printed to the changelog as-is.

Expected:
**scope:** subject

Actual:
type(scope): subject

Different host for repository and issues

Is it possible to have different host for repository(git) and issues tracking? so that link to commit number points to repository host and "closes" points to issue tracking host. I am using bitbucket as repository and JIRA as issue tracking.

Redesign API

Edit: TBH not too many people would config the API and they usually just use the default one or a preset. But if they do, they only change a small part. I believe an array of functions should solve this.

Attach the commit on the note

https://github.com/stevemao/conventional-changelog-writer/blob/master/lib/util.js#L156

Allow version to be passed in asynchronously

Hello,

We are using conventional-changelog to generate a changelog for our release. Our release flow is something along the lines of:

• Figure out the release version
• Generate the changelog
• (some other stuff)
• Make a commit with the bumped version number and the generated changelog

We are using gulp to generate our changelog:

gulp.task('release-generate-changelog', () => {
  const newChangesStream = changelog(
    {preset: 'angular', warn: log, append: true},
    {version: <VERSION>},
    {},
    {noteKeywords: ['BREAKING CHANGE', 'DEPRECATION WARNING']},
    {transform: commitTransform}
  );

  const oldChangesStream = gulp.src('CHANGELOG.md')
    .pipe(map((file, cb) => cb(null, file.contents)));

  const latestChangesFileStream = newChangesStream
    .pipe(source('LATEST_CHANGES.md'));

  const changelogFileStream = series(newChangesStream, oldChangesStream)
    .pipe(source('CHANGELOG.md'));

  return merge(changelogFileStream, latestChangesFileStream)
    .pipe(gulp.dest('.'));
});

We want to get <VERSION> by using conventional-recommended-bump. However, conventional-recommended-bump works asynchronously, and conventional-commits-writer expects version to be passed in synchronously.

Is there some way we can give conventional-commits-writer the version asynchronously? Maybe the version option could accept a promise?

Thanks!

cc/ @stubbornella @matt-royal

spit error if there is any

expose repo owner :D

same as conventional-changelog-archived-repos/conventional-commits-parser#12

Default options might be better to be merged instead of assigned

change angular defaults to something more generic

prereleases should be patch