Add CodeBoarding architecture analysis - #103
Conversation
CodeBoarding review · analyzing…⏳ CodeBoarding is analyzing this pull request's architecture changes. run 33070420119 · attempt 1 |
![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: 3061efe289
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| # variables → Actions and every run calls Anthropic directly with it. | ||
| # Until that secret exists this is an empty string and the run falls back to | ||
| # CodeBoarding's free hosted tier (what id-token: write above is for). | ||
| llm_provider: anthropic |
There was a problem hiding this comment.
When ANTHROPIC_API_KEY is unset, including a license-only installation, forcing llm_provider: anthropic prevents the advertised hosted fallback: scripts/action/configure-auth.sh treats every non-openrouter provider as direct even with an empty key, so it neither starts the OIDC relay nor applies license_key, and analysis runs without provider credentials. The same setting appears in .github/workflows/codeboarding-sync.yml at line 50, so both review and sync fail in the documented keyless setup; select Anthropic only when its key exists or retain the hosted default otherwise.
Useful? React with 👍 / 👎.
| # trusted default-branch action, which can safely analyze a fork's head | ||
| # without executing its action.yml with this job's OIDC permission. | ||
| - uses: actions/checkout@v4 | ||
| - uses: CodeBoarding/CodeBoarding-action@v1 |
There was a problem hiding this comment.
For same-repository pull requests that modify action.yml or scripts/action/**, resolving @v1 executes the last published release instead of the proposed code, removing the deliberate dogfood coverage supplied by the deleted checkout plus uses: ./ path. A broken composite-action change can therefore leave this workflow green until after release; retain the local-action path for trusted PR events while continuing to use default-branch code for slash commands.
AGENTS.md reference: AGENTS.md:L12-L16
Useful? React with 👍 / 👎.
| # addition now; /codeboarding still refreshes on demand. 'closed' only | ||
| # cancels an in-flight review (see concurrency), it doesn't start one. | ||
| types: [opened, reopened, ready_for_review, closed] | ||
| types: [opened, reopened, ready_for_review, closed, synchronize] |
There was a problem hiding this comment.
When this commit is merged without being reworded or squash-merged under a compliant PR title, the subject Add CodeBoarding architecture analysis has no Conventional Commits prefix, so release-please treats it as unparseable and omits it from its automated release bookkeeping. Reword the commit and PR title with the appropriate prefix, such as ci: add CodeBoarding architecture workflows.
AGENTS.md reference: AGENTS.md:L52-L53
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: runs on every push to a pull request, keeping anarchitecture-diff comment current and uploading that PR’s analysis as a build artifact
for the viewer’s PR diff. Each run continues from the one before it, so a push costs a
fraction of a full analysis.
Both are needed: sync produces the baseline; review diffs against it.
Sync delivery
Sync commits the generated baseline directly to
main.One thing left: add your Anthropic key
These workflows are wired to run on your own Anthropic key. Add it as a repository
secret under Settings → Secrets and variables → Actions:
ANTHROPIC_API_KEYOrder doesn’t matter: the key is read when the workflow runs, so you can add the secret
before or after merging. Until it exists, runs fall back to CodeBoarding’s free hosted
tier (metered per account against a weekly limit) rather than failing, so merging is
always safe.
A CodeBoarding plan works too: add
CODEBOARDING_LICENSEinstead.It’s already wired, and is used whenever no provider key is set.
Opened for you by CodeBoarding.