Skip to content

Latest commit

 

History

History
301 lines (175 loc) · 19.1 KB

CHANGELOG.md

File metadata and controls

301 lines (175 loc) · 19.1 KB
Raw

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.0.3 (2017-12-08)

Note: Version bump only for package conventional-changelog-writer

2.0.2 (2017-11-13)

Note: Version bump only for package conventional-changelog-writer

2.0.1 (2017-09-01)

2.0.0 (2017-07-17)

Bug Fixes

  • cli: options format (41c813b)
  • cli: require file with absolute path (fe2b5fe), closes #13
  • cli: use absolute path to require context and options (08808fe)
  • cli: when it is not tty, it should exit if errors (aa8708c)
  • context: auto link references if repoUrl (d5d66f3)
  • context.version: only valid a semver can decide context.isPatch (8dbc53a)
  • date: should use committerDate not authorDate (fbdf73d)
  • deps: concat-stream should be in devdeps (e90881c)
  • deps: require split2 (59db605)
  • doFlush: correct logic (38e3c03), closes #19
  • doFlush: one it is the only potential release (3d600cf)
  • err: catch any possible error (c934f50)
  • error: handle errors properly (bde1200)
  • firstRelease: correct logic (ccc02e1)
  • functionify: should not change falsy values (1aed002)
  • generateOn: should pass the transformed commit (2b6cc6c)
  • host: auto removes "/" at the end of options.host (2bdadf0)
  • keyCommit: all fields of keyCommit overwrites context (63296b5), closes #5
  • linkReferences: can be changed to false (a56f9fd)
  • notes: do not include reverted notes (4e60fe2)
  • notesSort: defaults to sort on text (3511ffb)
  • options: only apply default transform in certain conditions (6080181)
  • partials: only register if its a string (915cbeb)
  • reverse: should be the other way (b4156e3)
  • template: commit template markdown (0949b5a)
  • linting (33ac525)
  • template: default commit template should handle unkown host (d1ed4fc)
  • template: remove an extra newline in footer (f6180c5)
  • template: should not html escape (e4e33ae)
  • template: tweak (ef6996a)
  • templates: generate correct url if only host exists (35f1799)
  • templates: incase partial is empty also don't ignore default partials (d90fb65)
  • transform: do not strip leading v (8e2da57)
  • transform: should work if any field is missing (fd413ed)

Features

  • defaults: merge default options and make it less angular (8e29f96), closes #3 #4
  • migrate repo to lerna mono-repo (793e823)
  • transform: if returns a falsy value this commit is ignored (9508ed6)
  • use new api of references and notes (4d27326)
  • cli: version can be passed directly as an input (cadf7af)
  • commit: raw object is attached to commit (2ea9f04)
  • commit.hbs: scope can be missing (82e0ffa)
  • commit.hbs: use header if subject is missing (5e475a0)
  • compareFunc: these values can be string or array (464988c)
  • compareFunc: use module "compare-func" (520014e)
  • context: expose finalizeContext to modify context at last (d5545c0)
  • context: fallback to repoUrl (dc9c626)
  • context: linkReferences has nothing to do with context.host (1656df8)
  • debug: convient function for debugging (c041e35)
  • flush: add options.doFlush to make it possible not to flush (2fdf142)
  • generate: originalCommits as last argument (797fa8c)
  • generateOn: also pass commits, context and options to the function (a59c73c), closes ajoslin/conventional-changelog#135
  • generateOn: by default if commit.version is a valid semver (19ad3b1)
  • generateOn: if the commit is ignored fall back on the original (be5723a)
  • generateOn: log doesn't have to be generated once (ff88a62)
  • generateOn: other type to disable (9c50b90)
  • includeDetails: return an object that contains more details (81e79f7)
  • map: change options.replacements to options.map (d0a04ef)
  • maxSubjectLength: added (83c98b9)
  • noteGroups: remove and add note title transform (abedbfd)
  • notes: attach the commit to the note (af89d4a), closes #12
  • owner: add owner context (8d7b5d9), closes #7
  • reverse: new options for commits that are poured reversely (613651e)
  • revert: ignore reverted commits (0f279ad)
  • transform: add a transform option (b05dc2e), closes #2
  • transform: also pass context as an arg (76b869d)
  • version: is not a required field any more (3790d8f)
  • version: strip leading v by default (43c2c7e)

Performance Improvements

  • get/set: drop dot-prop and just use lodash (601e580)

BREAKING CHANGES

  • context: context.host cannot change the default of context.linkReferences because if the host is unknown, context.host is undefined and all links will just use context.repository.
  • The upstream must use the new api of references and notes.

closes now becomes references The notes object is no longer a key-value object but an array of note object, such as

{
title: 'BREAKING AMEND',
text: 'some breaking change'
}
  • notes: includeDetails will only include log and keyCommit.
  • templates: If partials is not empty, it should not ignore header, commit and footer partials.
  • reverse: when there is no commits left for the last block of logs it will still try to generate one. (Assume commits might be rebased or lost but still need a new version).
  • noteGroups: options.noteGroups is no longer available. Filter the notes from upstream or in options.transform instead.
  • notes: notes in noteGroups is not an array of simple string any more but object. You must use note.text to access the equivalent of previous note.
  • cli: Previously version number has to be passed as a flag. As a version number is compulsory, it does not make sense for a flag to be compulsory. So if a version number is passed as an input it is still valid.
  • transform: options.hashLength, options.maxSubjectLength and options.map are deprecated in favour of options.transform.
  • map: options.replacements is now options.map and it can also take functions
  • compareFunc: commitGroupsCompareFn -> commitGroupsSort, commitsCompareFn -> commitsSort, noteGroupsCompareFn -> noteGroupsSort and notesCompareFn -> notesSort
  • compareFunc: Default compare functions no longer sort by lexicographical order. They use localeCompare instead
  • version: version is not a required field and it is moved to the context object. If version is found in the last commit, it will be overwritten.

1.4.1 (2016-05-10)

Bug Fixes

  • context: auto link references if repoUrl(30bb234)

1.4.0 (2016-05-10)

Features

  • context: fallback to repoUrl(e504682)

1.3.0 (2016-05-08)

Features

  • debug: convient function for debugging(3b6233f)

1.2.1 (2016-04-19)

Bug Fixes

  • templates: generate correct url if only host exists (bda0328)

1.2.0 (2016-04-17)

Features

  • transform: also pass context as an arg (9bd984c)

1.1.1 (2016-02-29)

1.1.0 (2016-02-08)

Features

  • generate: originalCommits as last argument (186bfb9)

1.0.3 (2016-02-06)

Bug Fixes

  • firstRelease: correct logic (43552a2)

1.0.2 (2016-02-06)

Bug Fixes

  • doFlush: one it is the only potential release (cc3b5db)

1.0.1 (2016-02-06)

Bug Fixes

1.0.0 (2016-02-05)

0.5.1 (2016-02-03)

Bug Fixes

  • context.version: only valid a semver can decide context.isPatch (59ed325)

0.5.0 (2016-02-02)

Features

  • flush: add options.doFlush to make it possible not to flush (7850589)

0.4.2 (2016-01-18)

Features

0.4.1 (2015-09-30)

Bug Fixes

  • template: default commit template should handle unkown host (ef62bfd)

Features

  • context: linkReferences has nothing to do with context.host (f5883a6)

BREAKING CHANGES

  • context.host cannot change the default of context.linkReferences because if the host is unknown, context.host is undefined and all links will just use context.repository.

0.4.0 (2015-09-23)

Bug Fixes

  • cli: require file with absolute path (e9d9702), closes #13
  • notesSort: defaults to sort on text (6d3d564)

Features

  • notes: attach the commit to the note (2977336), closes #12

BREAKING CHANGES

  • notes in noteGroups is not an array of simple string any more but object. You must use note.text to access the equivalent of previous note.