UNPKG

keep-a-changelog

Version:

Parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.

193 lines (157 loc) 7.08 kB
# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/). ## [3.0.4] - 2026-05-22 ### Fixed - Node types (again) [#67] ## [3.0.3] - 2026-05-13 ### Fixed - Node types [#67] ## [3.0.2] - 2026-02-24 ### Fixed - NPX executable [#64] ## [3.0.1] - 2026-02-21 ### Fixed - NPM imports in the Deno version. ## [3.0.0] - 2026-02-21 ### Changed - Use Node APIs instead of Deno for better compatibility. - --create option requires a value. - The default branch is now main instead of master ### Removed - JSR package because it's already published on NPM which is compatible with JSR. - Unmaintained Deno shim dependency. The build to Node is done with a custom script. ## [2.8.0] - 2026-01-08 ### Added - `--create` option accepts 'minor', 'major' and 'patch' values ## [2.7.1] - 2025-09-14 ### Fixed - BitBucket URLs improperly parsed [#62] ## [2.7.0] - 2025-09-07 ### Added - Support for BitBucket URLs [#61] ## [2.6.2] - 2025-03-23 ### Added - New option `--latest-release-full` to print the full release [#59] ## [2.6.1] - 2025-02-24 ### Fixed - NPM publishing [#55], [#56]. ## [2.6.0] - 2025-02-22 ### Added - New option `--no-v-prefix` to generate the tag names without prepending `v` [#43] - New option `--no-sort-releases` to disable sorting of releases [#51] - New option `--bullet-style` for customizing the bullet point character used in unordered lists [#48] - Add Azure DevOps URL support [#49] - New option `--combine` to combine changes with the same version [#50] - `--help, -h` flag [#45]. ### Fixed - Updated dependencies - Skip release creation if it already exists [#47] ## [2.5.3] - 2023-11-19 ### Fixed - Improve URL normalization in CLI [#42] ## [2.5.2] - 2023-11-09 ### Fixed - Url regex for gitlab links [#41] ## [2.5.1] - 2023-11-08 ### Fixed - Url parser for gitlab links [#40] ## [2.5.0] - 2023-11-07 ### Added - Automatic detection of github and gitlab urls and build the links accordingly [#35] - New option --head to set the HEAD name [#37] ### Changed - Deprecated function `compareLinkBuilder`, use `tagLinkBuilder` instead ### Fixed - Trailing slash of the remote url is now removed [#36] - Updated dependencies ## [2.4.1] - 2023-10-10 ### Fixed - Breaking changes after updating `semver` package ## [2.4.0] - 2023-10-10 ### Added - New function `compareLinkBuilder` [#33]. ### Fixed - Updated dependencies ## [2.3.0] - 2023-05-25 ### Added - New option `--create`, to create unreleased versions [#31]. ### Fixed - Allow empty values for `--release` option - Updated dependencies ## [2.2.1] - 2023-01-25 ### Fixed - Allow list elements in the descriptions of releases and changelogs [#30]. ## [2.2.0] - 2023-01-18 ### Added - New option `format` to configure the output option [#28]. - `Release.setYanked` function [#26]. ### Fixed - Removed unnecessary new line after the title [#27]. ## [2.1.0] - 2022-04-03 ### Added - Support for `[YANKED]` releases [#25] ### Fixed - Updated dependencies ## [2.0.1] - 2022-01-09 ### Fixed - Updated deps. - `release` and `latest-release` args [#23]. ## [2.0.0] - 2021-12-08 New version merging Deno and Node code using Deno's `dnt` package. ### Changed - Code converted to TypeScript. - Added the link of the first version [#21]. [#21]: https://github.com/oscarotero/keep-a-changelog/issues/21 [#23]: https://github.com/oscarotero/keep-a-changelog/issues/23 [#25]: https://github.com/oscarotero/keep-a-changelog/issues/25 [#26]: https://github.com/oscarotero/keep-a-changelog/issues/26 [#27]: https://github.com/oscarotero/keep-a-changelog/issues/27 [#28]: https://github.com/oscarotero/keep-a-changelog/issues/28 [#30]: https://github.com/oscarotero/keep-a-changelog/issues/30 [#31]: https://github.com/oscarotero/keep-a-changelog/issues/31 [#33]: https://github.com/oscarotero/keep-a-changelog/issues/33 [#35]: https://github.com/oscarotero/keep-a-changelog/issues/35 [#36]: https://github.com/oscarotero/keep-a-changelog/issues/36 [#37]: https://github.com/oscarotero/keep-a-changelog/issues/37 [#40]: https://github.com/oscarotero/keep-a-changelog/issues/40 [#41]: https://github.com/oscarotero/keep-a-changelog/issues/41 [#42]: https://github.com/oscarotero/keep-a-changelog/issues/42 [#43]: https://github.com/oscarotero/keep-a-changelog/issues/43 [#45]: https://github.com/oscarotero/keep-a-changelog/issues/45 [#47]: https://github.com/oscarotero/keep-a-changelog/issues/47 [#48]: https://github.com/oscarotero/keep-a-changelog/issues/48 [#49]: https://github.com/oscarotero/keep-a-changelog/issues/49 [#50]: https://github.com/oscarotero/keep-a-changelog/issues/50 [#51]: https://github.com/oscarotero/keep-a-changelog/issues/51 [#55]: https://github.com/oscarotero/keep-a-changelog/issues/55 [#56]: https://github.com/oscarotero/keep-a-changelog/issues/56 [#59]: https://github.com/oscarotero/keep-a-changelog/issues/59 [#61]: https://github.com/oscarotero/keep-a-changelog/issues/61 [#62]: https://github.com/oscarotero/keep-a-changelog/issues/62 [#64]: https://github.com/oscarotero/keep-a-changelog/issues/64 [#67]: https://github.com/oscarotero/keep-a-changelog/issues/67 [3.0.4]: https://github.com/oscarotero/keep-a-changelog/compare/v3.0.3...v3.0.4 [3.0.3]: https://github.com/oscarotero/keep-a-changelog/compare/v3.0.2...v3.0.3 [3.0.2]: https://github.com/oscarotero/keep-a-changelog/compare/v3.0.1...v3.0.2 [3.0.1]: https://github.com/oscarotero/keep-a-changelog/compare/v3.0.0...v3.0.1 [3.0.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.8.0...v3.0.0 [2.8.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.7.1...v2.8.0 [2.7.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.7.0...v2.7.1 [2.7.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.6.2...v2.7.0 [2.6.2]: https://github.com/oscarotero/keep-a-changelog/compare/v2.6.1...v2.6.2 [2.6.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.6.0...v2.6.1 [2.6.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.3...v2.6.0 [2.5.3]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.2...v2.5.3 [2.5.2]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.1...v2.5.2 [2.5.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.0...v2.5.1 [2.5.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.4.1...v2.5.0 [2.4.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.4.0...v2.4.1 [2.4.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.3.0...v2.4.0 [2.3.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.2.1...v2.3.0 [2.2.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.2.0...v2.2.1 [2.2.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.1.0...v2.2.0 [2.1.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.0.1...v2.1.0 [2.0.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.0.0...v2.0.1 [2.0.0]: https://github.com/oscarotero/keep-a-changelog/releases/tag/v2.0.0