Skip to content

docs: clarify local check vs CI steps #106

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

Closed
kingrubic wants to merge 1 commit into from
Closed

docs: clarify local check vs CI steps #106

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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Registered at user scope by `agentctx init`; runs as `agentctx mcp`.
- Node 20/22/24 support matrix enforced at `init` (OQ-1 resolved); ABI-mismatch and missing-prebuild failures on unsupported Node versions are translated into actionable support-matrix guidance (`cli/node-support.ts`) instead of a stack trace; native code is never compiled on the install path
- End-to-end test (`test/e2e.test.ts`): init → hook invocations with fixture payloads → mocked Anthropic API extraction → consolidation → SessionStart digest correctness; both injection budgets asserted (≤1,500 / ≤2,000 tokens); session dedup verified; extraction cost lands on the session row
- Invariant audit: superseded records do not surface in any default path (hooks, MCP, CLI search/export/status); concurrent WAL writes verified safe; hooks exit 0 against missing and corrupt stores
- 287 tests across unit, integration, and end-to-end suites; `npm run check` (lint + typecheck + test) is the CI gate
- 287 tests across unit, integration, and end-to-end suites; CI runs lint plus the build/test matrix, while `npm run check` is the full local gate (lint + typecheck + build + test)

---

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ npm ci # install (Node ≥ 20, see .nvmrc)
npm run build # compile TypeScript
npm run test # vitest
npm run lint # biome (lint + format)
npm run check # everything CI runs
npm run check # local full gate: lint + typecheck + build + test
```

## Contribution Standards
Expand Down Expand Up @@ -67,4 +67,4 @@ signature is required. Opening a PR constitutes agreement.
## Questions

Open a [GitHub Discussion](https://github.com/agentctxhq/agentctx/discussions)
for anything that is not a bug or feature request.
for anything that is not a bug or feature request.
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ npm ci # install workspace dependencies
npm run build # compile TypeScript (all packages)
npm run test # run tests (vitest)
npm run lint # lint + format check (biome)
npm run check # lint + typecheck + test, what CI runs
npm run check # local full gate: lint + typecheck + build + test
```

Requires Node ≥ 20 (see `.nvmrc`).
Expand Down
Loading