Add CodeBoarding architecture analysis - #1
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
This PR doesn't fully meet our contributing guidelines and PR template. What needs to be fixed:
Please edit this PR description to address the above within 2 hours, or it will be automatically closed. If you believe this was flagged incorrectly, please let a maintainer know. |
|
Hey! Your PR title Please update it to start with one of:
Where See CONTRIBUTING.md for details. |
1 similar comment
|
Hey! Your PR title Please update it to start with one of:
Where See CONTRIBUTING.md for details. |
CodeBoarding review · analyzing…⏳ CodeBoarding is analyzing this pull request's architecture changes. run 36074819292 · attempt 1 |
Preview first, merge when ready
View your map · Configure & merge
The preview runs on this pull request. Merge the workflows to keep maps updated. Settings can be changed in this same pull request before merging.
This PR adds the CodeBoarding GitHub Action via two workflows:
codeboarding-sync.yml: on every push todev, 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
dev.Works out of the box
Just merge it: the Action runs on the free tier, with no secret to add. 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?
Switching is a change to these workflow files rather than a secret you add, because the
file names which credentials a run uses. Use Configure & merge in the viewer to pick:
others.
Before merging, this updates the same setup pull request and tells you which secret to
add under Settings → Secrets and variables → Actions.
After merging, use repository settings in the dashboard to open an update PR.
Opened for you by CodeBoarding.