Skip to content

1.5.7

Choose a tag to compare

@tobrien tobrien released this 12 Feb 04:41
· 4 commits to working since this release
e43dcbd

Summary

This release increments the package to version 1.5.7 and contains package metadata and build/dev tooling refreshes. No functional code or API surface changes were made — the update is limited to package.json adjustments (version, scripts, dependency metadata).

What changed

  • package.json
    • Version bumped to 1.5.7.
    • Package metadata and scripts were refreshed (build/test/lint/prepublish scripts present/validated).
    • Dependency section and devDependencies updated/confirmed (notable entries: @grunnverk/git-tools, @octokit/rest, TypeScript, Vite, Vitest, eslint toolchain, winston listed as a peer dependency).
    • Node engine declared as ">=24.0.0".
    • Files published include dist and guide.

There were 3 commits total in this release range; all are chore/package type changes focused on package.json.

Why this matters

  • Versioning: The package version was advanced to 1.5.7 so downstream consumers and package registries will pick up the latest package metadata.
  • Tooling consistency: The scripts and devDependencies in package.json ensure the repository’s build, lint, and test workflows are defined and up to date for developers.
  • Dependency clarity: Declared runtime and peer dependencies (including an optional winston peer) and the Node engine requirement make environment setup and compatibility easier to reason about.

Impact on users and developers

  • Consumers: No code-level or API changes — upgrading to 1.5.7 should not change runtime behavior. This release is safe to adopt for bugfix/metadata alignment purposes.
  • Developers/contributors: Build, lint, and test scripts are available and expected to run against the declared devDependencies (TypeScript, Vite, Vitest, ESLint, etc.). Node >= 24.0.0 is required for development and runtime.

Breaking changes

  • None detected. A scan for breaking changes found no obvious API or runtime breaking modifications. The only changes are package metadata and tooling-related. Manual review is always recommended if you have custom automation that depends on exact package.json fields, but no breaking API changes were made.

Upgrade notes

  • No code changes required. To update, bump your dependency to 1.5.7 as usual.
  • Ensure your environment meets the declared engine: Node >= 24.0.0.
  • winston is declared as an optional peer dependency — if you rely on logging integration with this package, ensure your project provides a compatible winston version (peer: ^3.17.0) or accept that it is optional.

Additional notes

  • Release follows existing versioning pattern (previous tag v1.5.6).
  • Commits in this release are categorized as chore/package and focus on package configuration and developer tooling.