Skip to content

1.5.6

Choose a tag to compare

View all tags
@tobrien tobrien released this 02 Feb 16:38
· 5 commits to working since this release
v1.5.6
ade773c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Summary — what this release does

This release updates package metadata, developer tooling, and dependency constraints. It is a small release (one file changed: package.json) that prepares the package for continued development and publishing under version 1.5.6.

Contributors: Tim O'Brien

Why this matters

  • Keeps dev tooling and build scripts up to date so contributors have a consistent, modern workflow.
  • Updates runtime and dependency constraints to reflect tested/expected environments.
  • No functional code changes were made to library source files, so runtime behavior is unchanged (see “Breaking changes” below).

Key changes

All changes are in package.json.

  • Version

    • Bumped package version to 1.5.6.

  • Node engine requirement

    • engines.node set to ">=24.0.0"
    • Impact: development, CI, and any environment that runs build/test must use Node 24 or newer.

  • Dependencies

    • @grunnverk/git-tools: ^1.5.15
    • @octokit/rest: ^22.0.0
    • These are runtime dependencies used by the package (no source/API changes in this release).

  • Peer dependencies

    • winston remains a peer dependency (optional). peerDependenciesMeta marks it optional.

  • DevDependencies and build/test tooling (selected updates)

    • Typescript ^5.9.2
    • Vite ^7.1.2
    • Vitest ^4.0.13
    • eslint and related ESLint tooling updated
    • esbuild, @swc/core and vite-plugin-* entries present/updated
    • These updates modernize the local development and CI toolchain.

  • Scripts

    • build: runs lint, TypeScript check (noEmit) and vite build
    • test: runs vitest with coverage
    • lint and lint:fix remain in place
    • precommit and prepublishOnly enforce clean, lint, build, and test steps
    • These scripts emphasize verifying lint/build/test before publishing.

What problems this release solves

  • Keeps the repository aligned with recent toolchain versions and dependency constraints to avoid long-lived drift and future upgrade pain.
  • Ensures the package is published with the correct metadata and validated by lint/build/test via the updated scripts.

Impact on users and developers

  • Developers:

    • Must run Node 24+ locally and in CI to build or test the project.
    • May need to update local tooling or global binaries (Node, any editor integrations) to match new devDependency versions for consistent dev experience.
    • Precommit and prepublishOnly scripts run lint/build/test; CI should satisfy these checks or adjust as needed.

  • Library consumers:

    • No changes to runtime API or code in this release — consumers should not see behavioral changes.
    • Peer dependency (winston) still optional; no change in expectations there.

Breaking changes

  • No functional or API breaking changes were detected in source code.
  • The only potential break is the raised Node engine requirement (>=24.0.0). That is an environment-level breaking change: systems using Node <24 will be unable to run build/test or may get an engine violation from package managers.

Upgrade notes / migration steps

  • Ensure Node 24+ is installed in developer machines and CI.
  • Run:
    • npm ci (or npm install) to pick up the updated dependency versions.
    • npm run lint, npm run build, npm run test locally to confirm environment is configured correctly.
  • If your CI pins older Node versions, update the CI configuration to Node 24 or later.

Files changed

  • package.json — version bump and metadata/dev tooling/dependency updates (only file changed).

If you need a more detailed list of updated devDependency versions or help updating CI/dev environments to Node 24, refer to package.json or contact the maintainer listed in package.json (Tim O'Brien).

Assets 2
Loading