You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
One action, two modes: architecture review on every pull request, and a versioned, always-current architecture baseline on your main branch.
4
4
5
-
-**`mode: review`** (the default) — CodeBoarding analyzes your architecture before and after a change, comments on the PR with an inline Mermaid diagram and hosted webview link, and uploads the PR-specific analysis JSON/health outputs as a GitHub Actions artifact. It never commits generated files to the PR branch. Runs on `pull_request` and `issue_comment`.
5
+
-**`mode: review`** (the default) — CodeBoarding analyzes your architecture before and after a change, comments on the PR with an inline Mermaid diagram and hosted webview link, and uploads the PR-head `analysis.json` plus base-commit metadata as a GitHub Actions artifact. It never commits generated files to the PR branch. Runs on `pull_request` and `issue_comment`.
6
6
-**`mode: sync`** — CodeBoarding keeps your architecture analysis versioned and current on your branch: on every push it commits the `analysis.json` baseline, `static_analysis.pkl` cache pair, health report, and readable markdown (`.codeboarding/*.md`), so reviews diff against your current architecture and your architecture has real git history. Runs on `push`, `workflow_dispatch`, and `schedule`. See [sync mode](#keep-your-architecture-versioned-sync-mode).
7
7
8
8
Both modes run the [CodeBoarding](https://github.com/CodeBoarding/CodeBoarding) engine in CI: static analysis combined with LLM reasoning. They are designed to be used together — [sync mode keeps the baseline fresh that review mode diffs against](#how-the-two-modes-work-together) — but each works on its own.
@@ -23,7 +23,7 @@ Both modes run the [CodeBoarding](https://github.com/CodeBoarding/CodeBoarding)
23
23
- Builds or reuses a baseline architecture analysis for the PR base.
24
24
- Runs incremental analysis on the PR head, then diffs components and relationships.
25
25
- Posts a sticky PR comment with an inline Mermaid map. Green is added, yellow is modified, red (dashed) is deleted, for both nodes and edges.
26
-
- Uploads the PRanalysis outputs as a GitHub Actions artifact and links the hosted webview to that artifact instead of committing generated files to the PR branch.
26
+
- Uploads the PR-head `analysis.json` plus base-commit metadata as a GitHub Actions artifact and links the hosted webview to that artifact instead of committing generated files to the PR branch.
27
27
28
28
A PR comment looks like this:
29
29
@@ -287,7 +287,7 @@ Review mode does not need `contents: write`: PR-specific generated files are sto
287
287
|`diagram_md`| review | Path to the generated Mermaid markdown block on the runner. |
288
288
|`n_changed`| review | Number of changed components, counted recursively. |
289
289
|`truncated`| review |`true` when the graph was reduced to fit GitHub Mermaid limits. |
|`review_artifact_url`| review | GitHub Actions artifact URL containing the PR-head `analysis.json` and base-commit metadata. |
291
291
|`analysis_mode`| sync |`full` or `incremental`: whether the run rebuilt the analysis from scratch or reused the committed baseline. |
292
292
|`files_written`| sync | The generated files written for the docs commit. |
293
293
|`committed`| sync |`true` when a docs commit was pushed to `target_branch`; `false` when sync mode ran but had nothing to commit (or the push failed open). Empty only if sync mode did not run. |
Copy file name to clipboardExpand all lines: docs/COMMIT_STRATEGY.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ The engine writes these under `.codeboarding/`:
22
22
- ✅ `static_analysis.pkl` + `static_analysis.sha` — required for reliable warm-start incremental sync from the committed baseline.
23
23
24
24
**Upload in review mode:**
25
-
- ✅ PR base/head `analysis.json`, head health report, rendered diagram, and metadata — stored as a GitHub Actions artifact.
25
+
- ✅ PR-head `analysis.json` and metadata containing the PR base SHA plus the committed baseline SHA when one was found — stored as a GitHub Actions artifact.
26
26
27
27
> **Principle:** sync mode is the only git writer. Review mode never commits generated files to PR branches, so generated artifacts cannot conflict with `main` during merge.
28
28
@@ -51,6 +51,6 @@ Either way the head analysis is seeded from that directory and runs incrementall
51
51
| Artifact | Commit? | Where | Why |
52
52
|---|---|---|---|
53
53
|`analysis.json`| ✅ | sync commit on `main`; review artifact for PRs | diagram source |
54
-
|`health_report.json`| ✅ | sync commit on `main`; review artifact for PRs| warnings |
54
+
|`health_report.json`| ✅ | sync commit on `main`; computed in review for comments, not uploaded| warnings |
55
55
|`static_analysis.pkl`| ✅ | sync commit on `main` only | warm-start incremental baseline |
56
56
|`static_analysis.sha`| ✅ | with `static_analysis.pkl`| warm-start gate |
0 commit comments