Skip to content

docs(topics): tighten v0.2.0 release audit coverage #652

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

Merged
flyingrobots merged 2 commits into from
Jun 26, 2026
+28 −5
Merged

docs(topics): tighten v0.2.0 release audit coverage #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7d4b67
docs(topics): tighten v0.2.0 audit coverage
flyingrobots Jun 26, 2026
e8912d1
docs(topics): index descriptor fixture workflow
flyingrobots Jun 26, 2026
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
14 changes: 11 additions & 3 deletions docs/architecture/holmes-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/project-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 26, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don't document append until the workflow honors it

When a manifest sets commentMode: append, this now tells users it creates a new comment per run, but in the checked .github/workflows/wesley-holmes.yml the comment-report job only special-cases silent, and the comment script still finds any existing marked github-actions[bot] comment and calls updateComment. PRs using append will still get a single overwritten HOLMES comment, so this reference misleads operators choosing an audit-trail comment mode unless the workflow skips the update path for append or the docs state that append is not implemented.

Useful? React with 👍 / 👎.

| `silent` | Run automation and report artifacts without writing a PR comment. |

## Multi-Schema Manifest

```json
Expand Down
1 change: 1 addition & 0 deletions docs/topics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/` |
Expand Down
8 changes: 6 additions & 2 deletions docs/topics/holmes-ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand Down
2 changes: 2 additions & 0 deletions docs/topics/project-manifests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<schema-id>`.
- `commentMode` controls PR comment behavior for automation:
`update`, `append`, or `silent`.
- Target names are metadata. External modules own target behavior.

## Related Authority
Expand Down