Repository navigation
Polish: README, test suite, pinned CI - #8
Conversation
Add an H1 and bold one-line pitch under the banner, a CI status badge for .github/workflows/ci.yml, rename 'Quick start' to 'Quickstart', and add a 'Tested on' section built only from facts already documented in INSTALL.md, package.json engines and the CI workflow. Refresh version/test-count badges and the stale '347 tests' comment to the current 3.3.0 / 866. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Two previously untested pure modules: - compression: forces the local fallback via HEADROOM_CONFIG_DIR pointing at a missing dir; checks role-merging/truncation ratios, cache hits, and stats accumulation in state. - project-detector: node/rust/python/go detection, name extraction, fallback to directory name on bad JSON, priority order, and icon fallback. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Replace the ubuntu-latest/node-20 matrix with a single job pinned to ubuntu-24.04 on Node 22 (setup-node@v4 with npm cache covering both lock files). Use npm ci instead of npm install, skip the Puppeteer Chromium download, add paths-ignore for docs/assets, concurrency cancel-in-progress, and read-only token permissions. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dd41a406fd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| paths-ignore: ['**.md', 'docs/**', 'assets/**', 'LICENSE', 'NOTICE', 'TRADEMARK.md', '.gitignore'] | ||
| pull_request: | ||
| branches: [main, master] | ||
| paths-ignore: ['**.md', 'docs/**', 'assets/**', 'LICENSE', 'NOTICE', 'TRADEMARK.md', '.gitignore'] |
There was a problem hiding this comment.
Keep CI enabled for functional Markdown changes
When a push or PR changes only a built-in file such as src/commands/builtin/ship.md, **.md matches nested Markdown files too, so the workflow skips CI. These files define runtime commands and are copied into dist by the build, so changes to commands, agents, or skills receive no test or build check. Limit the exclusion to documentation paths; GitHub’s path-pattern docs confirm that **.md matches Markdown files throughout the repository.
Useful? React with 👍 / 👎.
Summary
.github/workflows/ci.yml,Quick start→Quickstart, new## Tested ontable built only fromINSTALL.md/package.jsonengines/ the CI workflow (no invented numbers). Version/test badges and the stale "347 tests" comment refreshed to 3.3.0 / 866. All existing content kept; real screenshots inassets/retained.tests/compression.test.ts(local fallback compression, cache, stats) andtests/project-detector.test.ts(node/rust/python/go detection, name fallback, priority, icon). No source changes were needed.ubuntu-24.04(no matrix),actions/setup-node@v4Node 22 withcache: npmcovering both lock files,npm ci→ lint → test → build → GUInpm ci && npm run build.paths-ignore,concurrencycancel-in-progress,permissions: contents: read,PUPPETEER_SKIP_DOWNLOAD=1(CI never drives a browser).Test run
Also run locally:
npm run lint(clean),npm run build(ok),cd gui && npm ci && npm run build(ok, ~1s). Tauri build not run locally. Note: plainnpm cifails on this machine because Puppeteer's Chromium download is blocked by the sandbox — hence the env var, which CI now sets too.Scan findings
Scan findings (working tree + full git history; nothing auto-fixed, history not rewritten)
Git history was not rewritten and nothing was auto-fixed; this PR only adds/edits README.md, two test files, and ci.yml.
Notes / follow-ups
README.mdstill says "New in 3.2" whilepackage.jsonis 3.3.0 — left as-is (content decision for the maintainer).gui/package.jsonis at 3.2.0 vs root 3.3.0; not touched..gitleaks.tomlallowlist for the fake tokens in test fixtures.🤖 Generated with Claude Code