mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
a11b9e9757
* chore: standardize daemon naming on "KTX daemon"
Replace inconsistent names ("KTX Python daemon", "KTX local embeddings
daemon", "KTX managed daemon", "Python daemon") with the single name
"KTX daemon" in CLI output, errors, command descriptions, test
assertions, smoke scripts, docs, AGENTS.md, issue templates, and
codecov flags. The daemon is a portable compute server with endpoints
for SQL analysis, semantic layer, LookML, database introspection, and
embeddings; the previous labels misrepresented it as embeddings-only or
exposed implementation details ("Python", "managed").
The "KTX Python runtime" concept (installed interpreter + packages) is
deliberately left as-is — it is a separate concept from the daemon
process.
* refactor(release): drop release-policy.json runtime dep and next branch
Strips the release-policy.json fallback from release-version.ts so the CLI
reads its version straight from packages/cli/package.json. dev → 0.0.0-private,
installed @kaelio/ktx → the real semver baked into the published package.json.
KtxCliPackageInfo collapses to { name, version, contextPackageName }; /health
no longer depends on version files surviving past a CI run.
Replaces the dual-branch (main + next) semantic-release model with a single-
branch model on main. rcs and stables interleave on the same branch via
{ name: 'main', prerelease: 'rc', channel: 'next' } / ['main']. Drops
@semantic-release/git and @semantic-release/changelog (nothing is committed
back to the repo on any channel) and the workflow's "Prepare next prerelease
branch" step plus the KTX_PRERELEASE_BRANCH plumbing. The git tag plus the
published npm artifact carry the version forward.
Updates docs/release.md, removes the two now-unused devDeps, regenerates
pnpm-lock.yaml. 611/611 @ktx/cli tests, 173/173 script tests, type-check,
biome, knip all clean.
* fix(release): don't throw on non-main branches at config-load time
knip loads .releaserc.cjs on every PR run, where GITHUB_REF_NAME is the
merge ref (e.g. 180/merge). The previous version of releaseBranches threw
immediately when the branch wasn't main, which made knip fail to evaluate
the config and then mis-flag @semantic-release/exec as an unused dep.
semantic-release already refuses to publish when the current branch doesn't
match a configured release branch, so the explicit throw was redundant.
Drop it (and the unused currentBranch helper) and replace the
"rejects releases from non-main" assertion with one that exercises a CI-
shaped GITHUB_REF_NAME and confirms the config loads.
137 lines
5.4 KiB
Markdown
137 lines
5.4 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 updates the
|
|
following files **inside the CI runner only**:
|
|
|
|
- `package.json` with the semantic-release version.
|
|
- `release-policy.json` with `publicNpmPackageVersion`, npm publish settings,
|
|
and the published package smoke-test version.
|
|
|
|
The artifact packaging, readiness, and smoke-test scripts read
|
|
`publicNpmPackageVersion` from `release-policy.json` within the same CI run.
|
|
Nothing reads these files at runtime — the daemon and CLI rely on the
|
|
published `package.json` (for the installed `@kaelio/ktx` package) or
|
|
`packages/cli/package.json` (for dev-tree runs from this repo, which always
|
|
report `0.0.0-private`). Because the metadata mutation never has to survive
|
|
the run, no commit is pushed back to `main`. The git tag plus the published
|
|
npm artifact carry the version forward.
|
|
|
|
The bundled Python runtime wheel also derives its version from
|
|
`publicNpmPackageVersion`. 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.
|