Skip to content

Remove in-repo docs site and deploy workflow; bump deps and release 4.4.67

Choose a tag to compare

View all tags
released this 12 Dec 16:01
· 14 commits to working since this release
v4.4.67
fdce269

Summary

This release removes the in-repo documentation site and its GitHub Pages deployment workflow, updates the test workflow configuration, bumps several Fjell package dependencies and dev-dependencies, and publishes a stable package version 4.4.67. Changes are drawn from the commit set for this release (see commit messages cited below).

Documentation and docs site

  • Remove in-repo documentation site files and configuration (commit 8fa39d8: "Update docs structure and workflow configuration"). Files removed include docs site config and source files such as:

    • docs/docs.config.ts (deleted)
    • docs/index.html (deleted)
    • docs/package.json (deleted)
    • docs/src/* (deleted, e.g. docs/src/main.tsx, docs/src/index.css, docs/src/test/setup.ts)
    • docs/tsconfig.json, docs/vite.config.ts, docs/vitest.config.ts, docs/tsconfig.node.json (deleted)
    • docs/public assets removed (e.g. docs/public/fjell-icon.svg) as part of the cleanup
      These deletions are visible in the diff and referenced by the "Update docs structure and workflow configuration" commit.

  • Rename/move a few previously public markdown files into docs/ root (preserve content as files moved):

    • docs/public/api-reference.md -> docs/API_REFERENCE.md (rename recorded in diff)
    • docs/public/examples-README.md -> docs/EXAMPLES.md (rename recorded in diff)
    • docs/public/README.md -> docs/README.md (rename recorded in diff)
      These renames appear in the diff as file moves (100% similarity entries).

Impact: The repository no longer contains the previous docs site source and the associated docs build configuration. If documentation was published from this repository (GitHub Pages or similar), the Pages deployment for the in-repo site has been removed — see CI changes below.

CI / GitHub Actions

  • Remove the GitHub Actions workflow that deployed documentation to GitHub Pages: .github/workflows/deploy-docs.yml was deleted (diff shows the entire file removed). This is part of the docs/workflow cleanup in commit 8fa39d8 ("Update docs structure and workflow configuration").

  • Adjust test workflow triggers: .github/workflows/test.yml was modified to remove some push triggers and simplify branch triggers (change visible in diff; part of the same commit). The file now ensures pull_request runs on main; previously the workflow included push triggers for branches like main, working, and feature/** (these push entries were removed in the diff). Review CI configuration if your automation relied on the previous push triggers.

Dependencies and package version

  • Publish stable package version 4.4.67 (commit 070a3e3: "Bump package version to stable release in package.json"). The commit message states the prerelease entry was removed and replaced with the stable "version": "4.4.67".

  • Bump several Fjell packages and dev-dependencies in package.json (commit cf46640: "Bump several Fjell package versions in package.json"). Specific updates recorded in the commit message:

    • @fjell/core: ^4.4.70 -> ^4.4.72
    • @fjell/http-api: ^4.4.61 -> ^4.4.62
    • @fjell/logging: ^4.4.62 -> ^4.4.65
    • @fjell/registry: ^4.4.79 -> ^4.4.80
    • @fjell/common-config (devDependency): ^1.1.31 -> ^1.1.36
    • Added devDependencies: @eslint/eslintrc ^3.3.1 and @eslint/js ^9.39.1

These dependency updates are present in package.json changes noted in the diff and summarized by the commit message.

Impact: Consumers or integrators should expect the package at version 4.4.67 and review the noted dependency bumps for any compatibility considerations.

Developer notes / Breaking changes

  • Documentation hosting: The removal of the in-repo docs site and the deploy-docs GitHub Actions workflow means the repository no longer builds and publishes the previous documentation site. If documentation was consumed from this repository's GitHub Pages, update documentation hosting or CI to the new location or process.

  • CI triggers: The test workflow no longer runs on the same push branch set as before (see changes to .github/workflows/test.yml). If automated pushes were relied upon for tests on branches like working or feature/*, update workflows or branch protection rules accordingly.

  • Versioning: The package.json version was changed from a prerelease entry to the stable version 4.4.67 (commit 070a3e3). Ensure downstream consumers reference the new stable version.

References (commits)

  • "Bump package version to stable release in package.json" — commit 070a3e3
  • "Bump several Fjell package versions in package.json" — commit cf46640
  • "Update docs structure and workflow configuration" — commit 8fa39d8

If any of these changes affect your automation or documentation hosting, review the changed files in the commits above and update CI/documentation hosting accordingly.

Assets 2
Loading