Skip to content

docs: clarify KB discovery and publishing links #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0thernet merged 1 commit into from
Aug 28, 2026
Merged

docs: clarify KB discovery and publishing links #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ kb history search packages/parser --root . --repo .. --json

## links

[npm](https://www.npmjs.com/package/@hraness/kb) ·
[github](https://github.com/hraness/kb) ·
[overview](https://hraness.com/kb)
[Install `@hraness/kb` from npm](https://www.npmjs.com/package/@hraness/kb) ·
[KB source on GitHub](https://github.com/hraness/kb) ·
[KB overview](https://hraness.com/kb)
<!-- hraness:kb-landing:end -->

## A knowledge base for your coding agents
Expand Down
7 changes: 5 additions & 2 deletions docs/publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ initial registry write follows a separate path.

## Bootstrap the npm package

Start from the current `main` commit after its required checks pass. Use Node
24, npm 11.19.0, and Bun 1.3.14. Do not create the matching Git tag yet.
This section records the one-time `0.17.1` bootstrap. Do not reuse the
interactive path for a later release; follow
[Stage a later version](#stage-a-later-version) instead. The bootstrap started
from the checked `main` commit with Node 24, npm 11.19.0, and Bun 1.3.14. The
matching Git tag was created only after the public package was verified.

1. Install without dependency lifecycle scripts and run the complete gate.

Expand Down
11 changes: 7 additions & 4 deletions scripts/npm-release-workflow.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,9 @@ describe("npm release workflows", () => {
const opening = readme.slice(0, 1_500).replace(/\s+/gu, " ").toLowerCase();
expect(opening).toContain(String(manifest.description).toLowerCase());
for (const link of [
"[npm](https://www.npmjs.com/package/@hraness/kb)",
"[github](https://github.com/hraness/kb)",
"[overview](https://hraness.com/kb)",
"[Install `@hraness/kb` from npm](https://www.npmjs.com/package/@hraness/kb)",
"[KB source on GitHub](https://github.com/hraness/kb)",
"[KB overview](https://hraness.com/kb)",
]) expect(readme).toContain(link);
});

Expand Down Expand Up @@ -311,6 +311,9 @@ describe("npm release workflows", () => {
]);
for (const required of [
"automatically starts",
"one-time `0.17.1` bootstrap",
"Do not reuse the\ninteractive path for a later release",
"[Stage a later version](#stage-a-later-version)",
"version is unchanged",
"protected `npm-stage` environment",
"reviewer `0thernet`",
Expand Down Expand Up @@ -405,7 +408,7 @@ describe("canonical npm package identity", () => {
});
const verified = await verifyNpmPackageIdentity(validInput);
expect(verified.fileCount).toBe(200);
expect(verified.unpackedBytes).toBe(4_860_653);
expect(verified.unpackedBytes).toBe(4_860_696);
expect(verified.sourceArchiveSha512).not.toBe(verified.registryArchiveSha512);

const originalTar = gunzipSync(sourceBytes);
Expand Down