Skip to content

Latest commit

 

History

History
676 lines (327 loc) · 37.5 KB

CHANGELOG.md

File metadata and controls

676 lines (327 loc) · 37.5 KB
Raw

Change Log

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

8.0.0 (2024-04-26)

⚠ BREAKING CHANGES

  • Node >= 18 is required
  • conventional-changelog-writer: formatDate option (#1189)
  • conventional-changelog-writer: align methods with other packages (#1182)
  • conventional-commits-filter: rewrite to TypeScript (#1178)
  • conventional-changelog-writer: rewrite to TypeScript (#1150)
  • Now all packages, except gulp-conventional-changelog, are ESM-only.

Features

  • conventional-changelog-writer: formatDate option (#1189) (8c4bbbe), closes #1186
  • conventional-changelog-writer: align methods with other packages (#1182) (7b13ec9)
  • conventional-changelog-writer: rewrite to TypeScript (#1150) (8af364f)
  • conventional-changelog-writer: timeZone option (#1162) (27f3642)
  • conventional-commits-filter: rewrite to TypeScript (#1178) (e0c7b06)
  • drop node 16 support (#1226) (ec69cfd)
  • move from CommonJS to ESM (#1144) (c5b859d)

Bug Fixes

7.0.1 (2023-09-10)

Bug Fixes

  • conventional-changelog-writer: fix transform async handlers (#1146) (be3901b)

7.0.0 (2023-08-26)

⚠ BREAKING CHANGES

  • Node >= 16 is required
  • Now all presets are exports preset config factory function. conventional-changelog-preset-loader now exports new loadPreset and createPresetLoader functions. If you are using presets indirectly, using preset name, no any changes in configuration needed, just upgrade packages to latest versions.

Features

Bug Fixes

6.0.1 (2023-07-09)

Bug Fixes

  • conventional-changelog-writer: pass commit deep copy to writer transformer (#1044) (208ffdb)
  • deps: update dependency semver to v7 [security] (#1021) (31fa409)

6.0.0 (2023-06-06)

⚠ BREAKING CHANGES

  • Node >= 14 is required

Code Refactoring

  • drop lodash from dependencies where it possible (#959) (a8b4e12)

5.0.1 (2021-12-29)

Bug Fixes

  • deps: patch the handlebars package for CVE-2021-23369 (1cfc3a1)

5.0.0 (2020-12-30)

⚠ BREAKING CHANGES

  • nested object properties no longer supported when sorting

Bug Fixes

  • drop compare-func making sort consistent across node versions (#729) (e0081a8)

4.1.0 (2020-12-29)

Features

  • add helper for parsing array of commits (#711) (e869fe6)

4.0.18 (2020-11-05)

Bug Fixes

  • deps: update dependency through2 to v4 (#657) (7ae618c)

4.0.17 (2020-06-20)

Bug Fixes

  • deps: update dependency compare-func to v2 (#647) (de4f630)

4.0.16 (2020-05-08)

Bug Fixes

4.0.15 (2020-05-08)

Bug Fixes

  • deps: update yargs-parser to move off a flagged-vulnerable version. (#635) (aafc0f0)

4.0.11 (2019-11-14)

Bug Fixes

4.0.10 (2019-10-24)

Bug Fixes

  • deps: update lodash to fix security issues (#535) (ac43f51)

4.0.8 (2019-10-02)

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

4.0.7 (2019-07-29)

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

4.0.6 (2019-05-18)

Bug Fixes

  • deps: update dependency semver to v6 (#458) (efaa7bb)

4.0.5 (2019-04-11)

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

4.0.4 (2019-04-10)

Bug Fixes

  • deps: update dependency through2 to v3 (#392) (26fe91f)

4.0.3 (2019-02-14)

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

4.0.2 (2018-11-01)

Bug Fixes

  • bad release of conventional-changelog-writer (b5da9af)

4.0.1 (2018-11-01)

Bug Fixes

  • Upgrade to Lerna 3, fix Node.js v11 error (#385) (cdef282)

    <a name="4.0.0"></a>

4.0.0 (2018-05-29)

Chores

  • package: set Node requirement to oldest supported LTS (#329) (cae2fe0)

Code Refactoring

BREAKING CHANGES

  • package: Set the package's minimum required Node version to be the oldest LTS currently supported by the Node Release working group. At this time, that is Node 6 (which is in its Maintenance LTS phase).
  • Anchor tags are removed from the changelog header templates. The rendered Markdown will no longer contain anchor tags proceeding the version number header that constitutes the changelog header. This means that consumers of rendered markdown will not be able to use a URL that has been constructed to contain a version number anchor tag reference, since the anchor tag won't exist in the rendered markdown.

It's stronly recomended consumers use the full URL path to the release page for a given version, as that URL is a permalink to that verison, contains all relavent release information, and does not, otherwise, rely on the anchor tag being excessible from the current page view.

As an example, for version 2.0.0 of a GitHub project, the following URL should be used:

3.0.9 (2018-03-28)

Bug Fixes

3.0.8 (2018-03-27)

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

3.0.7 (2018-03-27)

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

3.0.6 (2018-03-27)

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

3.0.5 (2018-03-22)

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

3.0.4 (2018-02-24)

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

3.0.3 (2018-02-20)

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

3.0.2 (2018-02-13)

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

3.0.1 (2018-02-13)

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

3.0.0 (2018-01-29)

Bug Fixes

BREAKING CHANGES

  • writer: Logic for generating release headings has been changed to make all heading levels the same (##/h2) for better compatibility with screen readers and parsers, and to conform to HTML semantics. Patch release titles are now wrapped in a <small> tag to maintain the visual hierarchy of the previous style.

Fixes #214

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.