Skip to content

Remove docs/site and CI, bump package and two dependency patch versions

Choose a tag to compare

View all tags
released this 20 Dec 12:40
· 18 commits to working since this release
v4.4.64
8f1e040

Overview

This release contains three coordinated repository-level changes visible to users and integrators:

  • the package was moved from a dev snapshot identifier to a stable patch version (package.json) (commit 057bbeb),
  • two patch-level dependency bumps in package.json for @fjell/core and @fjell/logging (commit a3f4021), and
  • removal of the documentation site sources, its CI action, and related docs configuration/backups (commit a1f689f).

Taken together, these edits do not change runtime code or public API surfaces in the library itself, but they change packaging metadata, dependency resolution, and the repository's documentation footprint — all of which have concrete implications for publishing, CI, and users who relied on in-repo docs.

Breaking Changes

  • Removed in-repo documentation and docs CI action (commit a1f689f):
    • Files deleted: API.md, GETTING_STARTED.md, docs/.gitignore, docs/.npmrc, and the docs build action at .github/actions/build-docs/action.yml. These deletions remove the repository copies of the API reference and quickstart guide.
    • Impact: Any CI workflows, scripts, or documentation references that expected these files or the composite action to exist will fail until updated. For example, a workflow invoking .github/actions/build-docs or tooling that reads API.md from the repo must be changed to point at an external documentation site or reintroduce equivalent files.
    • Migration guidance: If your project or automation depended on the docs being present in this repository, either restore the needed files from a backup or update pipelines to fetch documentation from the published site or another maintained location. The commit message explicitly calls out that callers of the deleted docs/build action or references to these files will need alternate locations or reintroduction (commit a1f689f).

New Features

  • None. All commits are metadata, dependency bumps, or deletions; no new runtime functionality was added.

Improvements

  • Move package version from dev snapshot to stable release (commit 057bbeb):

    • What changed: package.json version field was updated from a dev snapshot form ("4.4.64-dev.0") to a stable semver token ("4.4.64").
    • Why it matters: package managers and registries treat prerelease identifiers differently from stable versions. This change signals readiness for publishing a non-prerelease package and affects how clients and CI select versions (e.g., scripts that filter out prereleases will now include this release).
    • Practical action: CI/publish pipelines or scripts that gate on prerelease markers should be reviewed; local lockfiles (package-lock.json / pnpm-lock.yaml) should be regenerated via npm install or pnpm install so downstream installs resolve the intended published version. The commit explicitly notes these implications (commit 057bbeb).

  • Bump two internal dependency patch versions in package.json (commit a3f4021):

    • What changed: package.json dependency entries were updated:
      • "@fjell/core" from "^4.4.73" → "^4.4.74"
      • "@fjell/logging" from "^4.4.65" → "^4.4.66"
    • Why it matters: These are patch-level bumps (caret ranges preserved). They indicate the package will now resolve to newer patch releases of those dependencies, bringing bug fixes or small improvements from those packages into consumers' dependency tree.
    • Practical action: Run npm install / pnpm install to update the lockfile so CI and consumers resolve the intended patch releases. The commit message calls this out and notes no code changes were introduced here (commit a3f4021).

Bug Fixes

  • No code-level bug fixes were introduced in these commits. The dependency bumps may bring bug fixes from @fjell/core and @fjell/logging, but those fixes are part of the bumped packages (see commit a3f4021). The release itself contains only metadata and file deletions.

Refactoring / Repository Maintenance

  • Remove documentation site source and related workspace/backups (commit a1f689f):
    • What changed: The repository no longer contains the docs/ workspace artifacts (docs/.npmrc, docs/.gitignore), nor the local backup mapping (.kodrdriv-link-backup.json), nor the rendered top-level docs (API.md, GETTING_STARTED.md). It also removes the composite GitHub Action that built the docs (.github/actions/build-docs/action.yml).
    • Why it was done (as stated in the commit): to strip out the documentation site source/config and its CI build action from the repository.
    • How these changes are related: removing both the docs sources and their CI action is consistent — without source files the build action has no inputs. The removed backup mapping (.kodrdriv-link-backup.json) was a local artifact used for workspace linking; its deletion aligns with removing docs workspace configuration.
    • Implications: Repository size and maintenance surface are reduced, but the repository no longer hosts standalone docs. Consumers who previously relied on these files being present should look for alternative documentation sources (published site, package README, or a separate docs repo).

Developer Experience / CI

  • CI and local workflows that referenced the docs build action (.github/actions/build-docs/action.yml) or expected docs artifacts must be updated (commit a1f689f). The deleted action was a composite action that ran npm install and npm run build inside docs; any workflows that invoked it will now reference a missing path and fail.

  • After the package.json edits, developers should regenerate lockfiles to avoid accidental resolution to older dependency versions. Both the version bump (057bbeb) and the dependency bumps (a3f4021) include notes that lockfiles should be updated with npm install / pnpm install.

Security Updates

  • No direct security fixes are present in these commits. Removing executable doc-related scripts (if any) is not listed in the logs as a security action; treat this as a repository-organization change rather than a security patch.

Documentation Updates

  • The repository-level documentation files were removed (API.md, GETTING_STARTED.md) (commit a1f689f). There is no replacement added in this commit series. If documentation is required in-repo, reintroduce files or add a README that points to the published documentation location.

Migration and Operational Guidance

  • If you are publishing or running automated tooling that depends on this repo's docs or the docs build action:

    • Update CI workflows that invoked .github/actions/build-docs to either remove that step or point to an alternative action or external docs build pipeline (commit a1f689f).
    • If automation parsed API.md or GETTING_STARTED.md from the repo, switch to the published docs location (if available) or re-add the files to the repo.

  • After pulling this release locally or in CI, run a fresh install to update the lockfile so the dependency bumps take effect and the package version change is recorded in lockfiles:

    • npm install (or pnpm install) to regenerate package-lock.json / pnpm-lock.yaml, as noted in commits 057bbeb and a3f4021.

  • Review release pipelines and any scripts that filter prereleases versus stable releases. The package version was changed from a dev snapshot to a stable semver string (commit 057bbeb); scripts that previously excluded prereleases may now pick up this new release.

Files changed / removed (explicit list from commits)

  • package.json: version changed to "4.4.64" and dependencies bumped for @fjell/core and @fjell/logging (commits 057bbeb, a3f4021)
  • Deleted: .github/actions/build-docs/action.yml (commit a1f689f)
  • Deleted: API.md (commit a1f689f)
  • Deleted: GETTING_STARTED.md (commit a1f689f)
  • Deleted: docs/.npmrc and docs/.gitignore (commit a1f689f)
  • Deleted: .kodrdriv-link-backup.json (commit a1f689f)

Closing notes and recommended next steps

  • This release is primarily repository housekeeping and packaging stabilization rather than functional changes. The main actions for integrators are:
    1. Update CI/workflows that depended on the docs action or the presence of API.md / GETTING_STARTED.md (commit a1f689f).
    2. Run a fresh install to refresh lockfiles so the dependency and version changes are captured (commits 057bbeb and a3f4021).
    3. If you relied on the deleted docs, identify an alternative source (published documentation or reintroduce files) before upgrading.

All statements above are derived from the commit messages included with this release (commits 057bbeb, a3f4021, and a1f689f). No runtime code or API signatures were changed in these commits.

Assets 2
Loading