mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
2366b00301
* refactor(workspace): relocate @ktx/llm source into packages/cli/src/llm * refactor(workspace): rewrite @ktx/llm imports to relative paths * refactor(workspace): fold internal packages into cli * chore(workspace): gate dead-code with knip production mode Turn on production-mode knip plus an autofix run in pre-commit and the `pnpm dead-code` script, document the `/** @internal */` convention for test-only exports in AGENTS.md, annotate test-only exports across the CLI with that JSDoc, and drop dead exports/wrappers the new gate surfaced (e.g. `cli-project.ts`, `lookerRuntimeSourceToFileAdapterSource`, `createLocalScanEnrichmentProvidersFromConfig`, `PGLITE_OWNER_PROCESS_BACKEND_CAPABILITIES`, stale type re-exports). Replace the loose `ignoreIssues` allowlist in `knip.json` with explicit production entries so cross-package barrel leaks are caught. * refactor(cli): delete internal barrel index.ts files The 34 `index.ts` re-export barrels inside `packages/cli/src/` were holdovers from the pre-fold multi-workspace structure. Post-fold-in they served no production purpose: external consumers go through the single package main entry, and in-repo callers mostly imported through them only because the path was short. Internally, knip flagged most barrel re-exports as production-dead (only reached via tests). This change: - Deletes every internal barrel except `packages/cli/src/index.ts` (the published package entry). - Rewrites ~270 source/test files to import each name directly from the file that defines it. - Moves `tools/warehouse-verification/index.ts` to `create-warehouse-verification-tools.ts` (the function it defined locally) and updates its single consumer. - Renames `search/backend-conformance.ts` → `.test-utils.ts` to match the existing test-helper file convention. - Deletes 13 dead test-only chains (dbt-descriptions/*, live-database/extracted-schema, live-database/structural-sync, relationship-* feedback/review chain) plus their tests and a cascading orphan integration test. - Updates test mocks that pointed at deleted barrel paths (notion-client, connector barrels in scan/local-scan-connectors tests) to mock the source files instead. - Points the maintainer benchmark script (`scripts/relationship-benchmark-report.mjs`) at source files instead of `dist/context/scan/index.js`. - Drops the barrel `!` entries from `knip.json`; adds explicit production entries only for the benchmark code reached via dist by the maintainer script. Net: 413 files changed, ~1.2k insertions, ~9.4k deletions. `pnpm run dead-code` (Biome + knip default + knip production) and `pnpm run type-check` are clean; 2277 tests pass. * refactor(workspace): rename @ktx/cli to @kaelio/ktx and pack it directly Promote the CLI workspace package to the public name `@kaelio/ktx` and drop the separate `scripts/build-public-npm-package.mjs` wrapper. The CLI package is now publishable in place (`publishConfig.access: public`, `provenance: true`), so artifact packing uses `pnpm pack` against `packages/cli/` instead of assembling a parallel package tree. Updates all workspace filter invocations, docs, tests, and release readiness checks to reference the new package name, and folds the tarball-name helper into `scripts/public-npm-release-metadata.mjs`. * docs: align "agent clients" and "data agents" terminology Replace "client agents" with "agent clients" and "database agents" with "data agents" across AGENTS.md, README.md, the docs-site copy, and the matching setup-agents test description, matching the canonical vocabulary in docs/terminology.md. Also moves packages/cli/tsconfig.json's tsBuildInfoFile from node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive node_modules reinstalls. * refactor(release): single source of truth for package version Make packages/cli/package.json the single source of truth for the @kaelio/ktx version. publicNpmPackageVersion() now reads it directly, so artifact filenames, release-readiness checks, and the Python wheel version all derive from one field. The duplicate release-policy.json.publicNpmPackageVersion is removed. Previously the two fields could drift: tarballs were named kaelio-ktx-0.4.1.tgz while internally containing @kaelio/ktx@0.0.0-private. - update-public-release-version.mjs rewrites both Python pyproject.toml files (ktx-daemon, ktx-sl) alongside the npm package.jsons, normalizing the version for PEP 440 (e.g. 0.1.0-rc.2 -> 0.1.0rc2). - semantic-release-config.cjs adds the two pyproject.toml files to @semantic-release/git assets so the release commit back to main carries every version source in lockstep. - The six "?? '0.0.0-private'" fallback literals across the CLI are replaced with "?? getKtxCliPackageInfo().version", and createDefaultKtxMcpServer makes its version arg required. - docs/release.md describes the actual commit-back model: the dev tree always reflects the most recent release; no sentinel pin to maintain. Verified: pnpm run artifacts:build now produces kaelio-ktx-0.4.1.tgz and kaelio_ktx-0.4.1-py3-none-any.whl with @kaelio/ktx@0.4.1 inside. Full type-check, dead-code, and 2287 vitests + 173 script tests pass. * refactor(cli): inject embedding provider resolution and detect sentence-transformers runtime Make resolveProjectEmbeddingProvider and runtimeIo injectable in ingest and scan command entrypoints so tests can stub them, and teach resolvePublicIngestRuntimeRequirements to flag the local-embeddings runtime feature when ktx.yaml selects sentence-transformers. * chore(cli): mark buildLocalStatsStatus and LocalStatsStatus as @internal Both symbols are consumed only by status-project.test.ts. Annotating with /** @internal */ keeps knip's production-mode check clean without changing runtime behavior. * fix(cli): use real package metadata in print-command-tree The stubbed package name embedded a forbidden product identifier that tripped the boundary check in CI. Read the metadata from package.json instead — keeps the rendered tree unchanged and removes a duplicate source of truth. * feat(cli): show embedding coverage in `ktx status`, drop duplicate disk counts Inline `(N embedded)` next to the Wiki scope counts and Semantic-layer source counts, computed with `SUM(embedding_json IS NOT NULL)` over `knowledge_pages` and `local_sl_sources`. Rename the "Knowledge" label to "Wiki" (canonical per `docs/terminology.md`) and rename the matching `localStats.knowledgePages` field to `localStats.wikiPages`. Drop `wiki=N md` and `semantic-layer=N yaml` from the Disk row — those duplicated the per-surface rows above. Disk now reports only actual byte usage (db, cache, raw-sources). The unused `wikiGlobalMarkdownCount` / `semanticLayerYamlCount` fields, the `isMarkdownEntry` / `isYamlEntry` helpers, and the `filter` arg on `summarizeDir` are removed.
146 lines
5.9 KiB
Markdown
146 lines
5.9 KiB
Markdown
# KTX release runbook
|
|
|
|
This runbook covers the maintainer workflow for publishing `@kaelio/ktx` to
|
|
npm through GitHub Actions. The workflow uses semantic-release to choose the
|
|
next version, update release metadata in the CI workspace, publish the
|
|
package, and create the GitHub release. No files are ever committed back to
|
|
the repository — the git tag and the published npm artifact are the source of
|
|
truth for any released version.
|
|
|
|
## Release channels
|
|
|
|
`main` is the bleeding-edge branch. Every release runs from `main`; the
|
|
dispatcher chooses the channel:
|
|
|
|
- `rc` publishes prereleases such as `0.3.0-rc.1` to the npm `next` tag.
|
|
- `stable` publishes normal releases such as `0.3.0` to the npm `latest` tag.
|
|
|
|
Tag history on `main` interleaves rc and stable tags
|
|
(`v0.2.0 → v0.3.0-rc.1 → v0.3.0-rc.2 → v0.3.0 → …`). semantic-release uses the
|
|
prerelease tags to graduate to the next stable cleanly.
|
|
|
|
The workflow rejects releases from any branch other than `main`.
|
|
|
|
## Prerequisites
|
|
|
|
Before you publish, confirm these requirements:
|
|
|
|
- npm Trusted Publishing is configured for `@kaelio/ktx`.
|
|
- The trusted publisher points at the `Kaelio/ktx` repository and the
|
|
`.github/workflows/release.yml` workflow.
|
|
- The workflow keeps `id-token: write` permission so npm can verify the
|
|
GitHub Actions run through OpenID Connect.
|
|
- The repository has release metadata in `release-policy.json` for the current
|
|
public package line, such as `0.1.0-rc.1` or `0.1.0`.
|
|
- The repository has a stable baseline tag when you need semantic-release to
|
|
publish the first stable version as `0.1.0`.
|
|
|
|
semantic-release doesn't support choosing an arbitrary first `0.x` stable
|
|
release. If KTX has no stable tag yet and you need the first stable release to
|
|
be `0.1.0`, create and push the baseline tag once before running the live
|
|
stable workflow:
|
|
|
|
```bash
|
|
root_commit="$(git rev-list --max-parents=0 HEAD | tail -n 1)"
|
|
git tag v0.0.0 "${root_commit}"
|
|
git push origin v0.0.0
|
|
```
|
|
|
|
KTX follows the same versioning schema as the main Kaelio release workflow:
|
|
breaking-change and `major` commit markers create a minor release, not an
|
|
automatic major release. A major version requires an intentional manual release
|
|
path.
|
|
|
|
## Dry-run a release
|
|
|
|
Use a dry-run to verify the next version and generated release notes without
|
|
publishing to npm.
|
|
|
|
1. Open **Actions** in GitHub.
|
|
2. Select **KTX Release**.
|
|
3. Select `main`.
|
|
4. Set **release_kind** to `rc` or `stable`.
|
|
5. Set **publish_live** to `false`.
|
|
6. Optional: Set **force_release** to `true` when you need a patch release even
|
|
if semantic-release doesn't find a releasable commit.
|
|
7. Run the workflow.
|
|
|
|
The dry-run uses the same semantic-release configuration as a live release. It
|
|
doesn't publish to npm and doesn't push any tags.
|
|
|
|
## Publish an rc release
|
|
|
|
Publish an rc release when you need a prerelease package for validation before
|
|
promoting to `latest`.
|
|
|
|
1. Open **Actions** in GitHub.
|
|
2. Select **KTX Release**.
|
|
3. Select `main`.
|
|
4. Set **release_kind** to `rc`.
|
|
5. Leave **publish_live** set to `true`.
|
|
6. Optional: Set **force_release** to `true`.
|
|
7. Run the workflow.
|
|
|
|
The workflow publishes `@kaelio/ktx` with `--access public --tag next`, runs
|
|
the published package smoke test, creates a GitHub release, and pushes the
|
|
`vX.Y.Z-rc.N` tag.
|
|
|
|
## Publish a stable release
|
|
|
|
Publish a stable release from `main` after you have validated an rc package.
|
|
|
|
1. Open **Actions** in GitHub.
|
|
2. Select **KTX Release**.
|
|
3. Select `main`.
|
|
4. Leave **release_kind** set to `stable`.
|
|
5. Leave **publish_live** set to `true`.
|
|
6. Optional: Set **force_release** to `true`.
|
|
7. Run the workflow.
|
|
|
|
The workflow publishes `@kaelio/ktx` with `--access public --tag latest`, runs
|
|
the published package smoke test, creates a GitHub release, and pushes the
|
|
`vX.Y.Z` tag. semantic-release graduates from the most recent rc tag, so the
|
|
prior rc lineage is consumed cleanly.
|
|
|
|
## Release metadata
|
|
|
|
semantic-release calls `scripts/update-public-release-version.mjs` during the
|
|
prepare step before the exec publish command runs. That script rewrites the
|
|
following files in lockstep:
|
|
|
|
- `package.json` and `packages/cli/package.json` with the semantic-release
|
|
version.
|
|
- `python/ktx-daemon/pyproject.toml` and `python/ktx-sl/pyproject.toml` with
|
|
the same version, normalized for PEP 440 (e.g. `0.1.0-rc.2` →
|
|
`0.1.0rc2`). Branch-prefixed npm releases skip this step because they are
|
|
not published to PyPI.
|
|
- `release-policy.json` with the npm publish settings, release mode, and
|
|
published package smoke-test version. The package version itself is not
|
|
stored here; it is derived from `packages/cli/package.json.version` by
|
|
`scripts/public-npm-release-metadata.mjs`, so there is only one place that
|
|
owns the version.
|
|
|
|
The `@semantic-release/git` plugin then commits these files back to `main`
|
|
with the release tag (see `scripts/semantic-release-config.cjs`). As a
|
|
result, the dev tree always reflects the most recently published version —
|
|
there is no sentinel pin. `ktx --version` and the bundled Python wheel both
|
|
report whatever was last released.
|
|
|
|
At runtime the CLI reads its version from its own `package.json` via
|
|
`getKtxCliPackageInfo()` (`packages/cli/src/cli-runtime.ts`); the Python
|
|
daemon reads its version from installed-package metadata via
|
|
`importlib.metadata.version()` (`python/ktx-daemon/src/ktx_daemon/__init__.py`).
|
|
|
|
The bundled Python runtime wheel also derives its version from the same
|
|
single source. Stable npm versions are reused as-is, and rc versions are
|
|
normalized to Python's version format. For example, `0.1.0-rc.2` becomes
|
|
`0.1.0rc2` in the `kaelio-ktx` wheel filename and wheel metadata.
|
|
|
|
## npm authentication
|
|
|
|
The release workflow publishes through npm Trusted Publishing. It doesn't use
|
|
an `NPM_TOKEN` secret, and the publish step doesn't set `NODE_AUTH_TOKEN`.
|
|
|
|
If npm returns an authentication error, check the Trusted Publishing settings
|
|
for the `@kaelio/ktx` package before adding token-based authentication back to
|
|
the workflow.
|