Skip to content

Commit 70915c5

Browse files
committed
Rename 'canary' mode to 'quick' mode
- All docs, tests, defaults now use --mode quick - CLI still accepts --mode canary for backward compatibility - Bump version to 0.2.2
1 parent 02db1a2 commit 70915c5

12 files changed

Lines changed: 29 additions & 29 deletions

File tree

.github/actions/quick-gate/action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ author: Hermes Labs
44

55
inputs:
66
mode:
7-
description: Gate mode -- "canary" (lint + typecheck + lighthouse) or "full" (adds build)
7+
description: Gate mode -- "quick" (lint + typecheck + lighthouse) or "full" (adds build)
88
required: false
9-
default: canary
9+
default: quick
1010
repair:
1111
description: Run bounded repair after gate failures (deterministic-only in CI, no Ollama required)
1212
required: false

.github/workflows/example-usage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
- name: Run Quick Gate
2626
uses: roli-lpci/quick-gate-js/.github/actions/quick-gate@main
2727
with:
28-
mode: canary
28+
mode: quick
2929
repair: "true"
3030
max-attempts: "2"
3131
post-comment: "true"

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Requires **Node.js >= 18** and a project with dependencies installed (`npm ci`).
1313

1414
```bash
1515
# From your project directory:
16-
npx quick-gate run --mode canary --changed-files <path>
16+
npx quick-gate run --mode quick --changed-files <path>
1717

1818
# Or install globally:
1919
npm install -g quick-gate
@@ -24,12 +24,12 @@ Create a changed-files list (newline-delimited or JSON array):
2424

2525
```bash
2626
echo "app/page.tsx" > /tmp/changed.txt
27-
quick-gate run --mode canary --changed-files /tmp/changed.txt
27+
quick-gate run --mode quick --changed-files /tmp/changed.txt
2828
```
2929

3030
## What It Does
3131

32-
Quick Gate runs up to four deterministic quality gates on your project. In **canary** mode (default): lint + typecheck + lighthouse. In **full** mode: all four including build.
32+
Quick Gate runs up to four deterministic quality gates on your project. In **quick** mode (default): lint + typecheck + lighthouse. In **full** mode: all four including build.
3333

3434
1. **lint** -- runs your ESLint config
3535
2. **typecheck** -- runs TypeScript compiler
@@ -46,7 +46,7 @@ When gates fail, it produces structured evidence (not just exit codes) and optio
4646

4747
```bash
4848
# Run quality gates
49-
quick-gate run --mode canary|full --changed-files <path>
49+
quick-gate run --mode quick|full --changed-files <path>
5050

5151
# Generate agent brief from failures
5252
quick-gate summarize --input .quick-gate/failures.json
@@ -120,7 +120,7 @@ jobs:
120120
- run: npm ci
121121
- uses: roli-lpci/quick-gate-js/.github/actions/quick-gate@main
122122
with:
123-
mode: canary
123+
mode: quick
124124
repair: "true"
125125
post-comment: "true"
126126
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "quick-gate",
3-
"version": "0.2.1",
3+
"version": "0.2.2",
44
"description": "Deterministic quality gate CLI for TypeScript and ESLint projects with bounded auto-repair and escalation evidence",
55
"type": "module",
66
"bin": {

schemas/agent-brief.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"mode": {
1818
"type": "string",
1919
"enum": [
20-
"canary",
20+
"quick",
2121
"full"
2222
]
2323
},

schemas/failures.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"mode": {
2323
"type": "string",
2424
"enum": [
25-
"canary",
25+
"quick",
2626
"full"
2727
]
2828
},

scripts/run_real_repo_experiment.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ function runProfile({ workspace, quickGateRepo, outRoot, profile, scenarioCount
195195
};
196196

197197
const runRes = run(
198-
`node '${path.join(quickGateRepo, 'src', 'cli.js')}' run --mode canary --changed-files changed-files-experiment.txt`,
198+
`node '${path.join(quickGateRepo, 'src', 'cli.js')}' run --mode quick --changed-files changed-files-experiment.txt`,
199199
workspace,
200200
env,
201201
900000,

src/cli.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ function usage() {
2727
console.log(`Quick Gate v${version}
2828
2929
Commands:
30-
quick-gate run --mode canary|full --changed-files <path>
30+
quick-gate run --mode quick|full --changed-files <path>
3131
quick-gate summarize --input .quick-gate/failures.json
3232
quick-gate repair --input .quick-gate/failures.json [--max-attempts 3] [--deterministic-only]
3333
@@ -52,8 +52,8 @@ async function main() {
5252

5353
try {
5454
if (cmd === 'run') {
55-
if (!args.mode || !['canary', 'full'].includes(String(args.mode))) {
56-
throw new Error('run requires --mode canary|full');
55+
if (!args.mode || !['quick', 'canary', 'full'].includes(String(args.mode))) {
56+
throw new Error('run requires --mode quick|full');
5757
}
5858
if (!args['changed-files']) {
5959
throw new Error('run requires --changed-files <path>');

test/cli.test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ test('run without --mode exits 1', () => {
5252
});
5353

5454
test('run without --changed-files exits 1', () => {
55-
const result = runCli(['run', '--mode', 'canary']);
55+
const result = runCli(['run', '--mode', 'quick']);
5656
assert.equal(result.code, 1);
5757
assert.ok(result.stderr.includes('--changed-files'));
5858
});
5959

6060
test('run with invalid mode exits 1', () => {
6161
const result = runCli(['run', '--mode', 'invalid', '--changed-files', '/tmp/test.txt']);
6262
assert.equal(result.code, 1);
63-
assert.ok(result.stderr.includes('--mode canary|full'));
63+
assert.ok(result.stderr.includes('--mode quick|full'));
6464
});
6565

6666
test('summarize without --input exits 1', () => {

test/gates-lighthouse.test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ test('lighthouse parser extracts route + threshold attribution', () => {
7676
};
7777

7878
const result = runDeterministicGates({
79-
mode: 'canary',
79+
mode: 'quick',
8080
cwd,
8181
config,
8282
changedFiles: ['app/about/page.tsx'],

0 commit comments

Comments
 (0)