diff --git a/docs/architecture/holmes-integration.md b/docs/architecture/holmes-integration.md index 3f5eb6d3..42041440 100644 --- a/docs/architecture/holmes-integration.md +++ b/docs/architecture/holmes-integration.md @@ -105,6 +105,14 @@ reports/ The PR comment builder detects that grouped layout and renders one anchored comment with separate sections for each schema set. +Manifest `commentMode` controls the final PR comment behavior: + +| Mode | Behavior | +| -------- | ------------------------------------------- | +| `update` | Create or update one anchored PR comment. | +| `append` | Create a new PR comment for each run. | +| `silent` | Run analysis but do not write a PR comment. | + ## Dashboard Artifact The workflow uploads `docs/holmes-dashboard` as a dashboard template and @@ -127,11 +135,11 @@ own repo or through an explicitly designed external target boundary. Useful focused checks: ```bash -cargo wesley config validate --json -cargo wesley config changed-schemas \ +cargo run --bin wesley -- config validate --json +cargo run --bin wesley -- config changed-schemas \ --changed test/fixtures/examples/ecommerce.graphql \ --json -bats -t test/ci-workflows.bats +BATS_LIB_PATH=test/vendor bats -t test/ci-workflows.bats node --test packages/wesley-holmes/test/pr-comment.test.mjs ``` diff --git a/docs/reference/project-manifest.md b/docs/reference/project-manifest.md index 5f4e8de7..56121a2b 100644 --- a/docs/reference/project-manifest.md +++ b/docs/reference/project-manifest.md @@ -58,6 +58,14 @@ Defaults: | `dashboard` | disabled | | `targets` | empty | +`commentMode` accepts: + +| Value | Behavior | +| -------- | ----------------------------------------------------------------- | +| `update` | Create or update one anchored automation comment. | +| `append` | Create a new automation comment for each run. | +| `silent` | Run automation and report artifacts without writing a PR comment. | + ## Multi-Schema Manifest ```json diff --git a/docs/topics/README.md b/docs/topics/README.md index bcfda10f..8c7c0c2c 100644 --- a/docs/topics/README.md +++ b/docs/topics/README.md @@ -14,6 +14,7 @@ short path to the authoritative surface. | ------------------------------------------------------------ | ------------------------------------------- | ------------------------------------------------------------ | | Decide whether a change belongs in Wesley or an extension. | [Compiler Boundary](./compiler-boundary.md) | `docs/design/0014-domain-empty-core-boundary/` | | Configure schema sets, changed-schema selection, or targets. | [Project Manifests](./project-manifests.md) | `docs/reference/project-manifest.md` | +| Author or review descriptor-only extension fixtures. | [Compiler Boundary](./compiler-boundary.md) | `docs/guides/module-authoring.md` | | Choose local checks before a PR or release. | [Validation](./validation.md) | `cargo xtask preflight`, `docs/governance/RELEASE_POLICY.md` | | Understand HOLMES CI and evidence artifacts. | [HOLMES CI](./holmes-ci.md) | `.github/workflows/wesley-holmes.yml`, `docs/architecture/` | | Prepare or judge a release. | [Releases](./releases.md) | `docs/method/release-runbook.md`, `docs/governance/` | diff --git a/docs/topics/holmes-ci.md b/docs/topics/holmes-ci.md index b26f6de3..473cb4ea 100644 --- a/docs/topics/holmes-ci.md +++ b/docs/topics/holmes-ci.md @@ -26,6 +26,10 @@ inventing work. - CodeRabbit and HOLMES are separate review surfaces. - HOLMES report artifacts are grouped by schema set. - The dashboard artifact is an artifact viewer, not a Wesley website product. +- `commentMode: silent` suppresses the aggregate PR comment; it does not skip + schema-set analysis or report artifacts. +- Invalid manifests fail the workflow. Legacy fallback is only for the + no-manifest case. - Missing or invalid report artifacts should be reported as unavailable or diagnostic evidence, not hidden behind a passing workflow. - Target-specific facts belong in external modules that generate their own @@ -34,8 +38,8 @@ inventing work. ## Local Checks ```bash -cargo wesley config validate --json -cargo wesley config changed-schemas --json +cargo run --bin wesley -- config validate --json +cargo run --bin wesley -- config changed-schemas --json BATS_LIB_PATH=test/vendor bats -t test/ci-workflows.bats node --test packages/wesley-holmes/test/pr-comment.test.mjs ``` diff --git a/docs/topics/project-manifests.md b/docs/topics/project-manifests.md index d4e8f15d..42c2a317 100644 --- a/docs/topics/project-manifests.md +++ b/docs/topics/project-manifests.md @@ -47,6 +47,8 @@ wesley config changed-schemas --changed-file changed-files.txt --json - Top-level rebuild globs select every schema set. - Schema-local rebuild globs select only that schema set. - Selected multi-schema bundles are isolated under `bundleDir/`. +- `commentMode` controls PR comment behavior for automation: + `update`, `append`, or `silent`. - Target names are metadata. External modules own target behavior. ## Related Authority