Skip to content

Latest commit

 

History

History
109 lines (87 loc) · 5.97 KB

CHANGELOG.md

File metadata and controls

109 lines (87 loc) · 5.97 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

3.1.0

Added

  • Allow prerelease versions in release headers (#130)

3.0.0

Added

  • Support alternate tag prefixes (#120)

Changed

  • BREAKING: Update minimum Node.js version to v14 (#117)
  • Get package version from manifest (#121)

2.6.1

Fixed

  • When fetching remote tags, order by date to account for miniscule time differences between tags created within automated tests (#113)

2.6.0

Changed

  • Read repository URL from package.json if npm_package_repository_url is not set (#111)
    • This makes this package compatible with Yarn >1.

2.5.0

Added

  • The validate --rc command now ensures there are no uncategorized changes in the current release entry (#102, #106)

2.4.0

Changed

  • Permit missing separating space in "Unreleased" link reference definition (#92)
  • Use execa to execute git commands (#94)
    • This may fix subtle bugs related to git command execution, especially in CI.

2.3.0

Added

  • More exports to index.ts (#86)
    • Specifically, the Changelog class, createEmptyChangelog, and parseChangelog.

Fixed

  • Correctly calculate the most recent git tag (#87) (#87)
    • Previously, we passed the path to the project root directory as a parameter to an invocation of git rev-list. For all repositories, this caused most tags belonging to merge commits to be excluded. For monorepos, this also caused tags belonging to commits that didn't change any files belonging to the changelog's package / workspace to be excluded.

2.2.0

Added

  • Add init command (#77)

Changed

  • Add @lavamoat/allow-scripts and setup command (#78)
  • Detect all PRs referenced in each change description, rather than just the first (#84)

Fixed

  • Fix broken validation and updating when the lowest SemVer release isn't the first chronological release (#76)
  • Fix PR number detection in existing change entries (#83)

2.1.0

Added

  • Add Changelog.getStringifiedRelease (#73)

Fixed

  • Remove trailing '.git' from default repo URL (#74)

2.0.1

Fixed

  • Prevent old build files from being published (#71)

2.0.0

Added

  • TypeScript types (#59)

Changed

  • (BREAKING) Move Pull Request links to end of change entries (#66)
  • Rename files to use snake-case (#64)
  • Validate change categories during parsing (#62)
    • This causes a validation error to be thrown earlier than previously.
  • Migrate to TypeScript (#59)

Fixed

  • Release candidate tag validation (#55)
    • The fixed check ensures that there are no existing tags for release candidates.
  • Typo in CLI error message (#65)

1.0.0

Added

  • The initial auto-changelog implementation, adapted from the original auto-changelog.js script in metamask-extension (#8). Includes the following features:
    • An update command (#26)
    • A validate command (#28)
    • Monorepo support (#41)
    • Configurable repository URL, version, and changelog file path (#33, #31, #30)