Add CodeBoarding architecture analysis - #3
Conversation
Architecture review · no architectural changesgraph LR
n_Mermaid_Diagram_Processor["Mermaid Diagram Processor"]
n_GitHub_Code_Extractor["GitHub Code Extractor"]
n_Markdown_Aggregator["Markdown Aggregator"]
n_Link_Sanitization_Utility["Link Sanitization Utility"]
n_Markdown_Aggregator -- "Optimizes visual logic for LLM consumption" --> n_Mermaid_Diagram_Processor
n_Markdown_Aggregator -- "Inlines source code into documentation" --> n_GitHub_Code_Extractor
n_Markdown_Aggregator -- "Sanitizes documentation noise" --> n_Link_Sanitization_Utility
classDef added fill:#1f883d,stroke:#0b5d23,color:#ffffff;
classDef modified fill:#bf8700,stroke:#7d4e00,color:#ffffff;
classDef deleted fill:#cf222e,stroke:#82071e,color:#ffffff,stroke-dasharray:5 3;
Colors indicate component changes compared to target branch Download the PR analysis artifacts from this workflow artifact. Explore this PR’s architecture in your browser or VS Code. codeboarding-action · run 30399037116 |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b2660cf31f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, reopened, ready_for_review, closed] |
There was a problem hiding this comment.
When commits are pushed to an already-open, non-draft PR, GitHub emits the synchronize action, which is absent from this explicit type list. Consequently, the architecture-diff comment and uploaded analysis remain tied to an older revision unless a repository collaborator notices and manually posts /codeboarding; include synchronize so the review reflects the current PR contents.
Useful? React with 👍 / 👎.
| name: CodeBoarding review | ||
|
|
||
| on: | ||
| pull_request: |
There was a problem hiding this comment.
For pull requests originating from forks, GitHub downgrades the pull_request workflow's GITHUB_TOKEN to read-only regardless of the requested pull-requests: write and issues: write permissions. In that common external-contributor scenario, the action cannot use this token to post its architecture-diff comment, so the advertised review is not delivered; use a safe privileged follow-up mechanism (without executing untrusted PR code with secrets) for comment publication.
Useful? React with 👍 / 👎.
1 participant
This PR adds the CodeBoarding GitHub Action via two workflows:
codeboarding-sync.yml— on every push tomain, commits.codeboarding/analysis.json(your architecture baseline + readable docs). This iswhat the CodeBoarding viewer opens.
codeboarding.yml— on every pull request, posts an architecture-diff comment anduploads that PR’s analysis as a build artifact for the viewer’s PR diff.
Both are needed: sync produces the baseline; review diffs against it.
Sync delivery
Sync opens and keeps one rolling CodeBoarding PR into
main; merge it to land the baseline.Works out of the box
Just merge it — the Action runs on the free tier, with no extra setup. The
id-token: writepermission lets it identify your repo to CodeBoarding’s hosted LLM,metered against a weekly limit for the repository owner.
Want more, or unmetered, usage?
The workflows already wire two repository secrets — just add whichever you have under
Settings → Secrets and variables → Actions and the next run picks it up (no YAML edit):
OPENROUTER_API_KEY— your own OpenRouter key (BYO key).CODEBOARDING_LICENSE— a CodeBoarding paid plan (unmetered).A key wins if both are set; the license is used only when no key is set; with neither,
the free tier runs with nothing configured. For a non-OpenRouter provider (Anthropic,
OpenAI, Google, AWS Bedrock, …) see the
provider list, or re-run
setup from the CodeBoarding viewer and pick one.
— opened for you by CodeBoarding