Repository navigation
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. |
CodeBoarding review · analyzing…⏳ CodeBoarding is analyzing this pull request's architecture changes. Open it in CodeBoarding meanwhile: the files, comments and review are there already, and the diff appears when the run finishes. run 38451096488 · 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: 03501b08c2
ℹ️ 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".
| runs-on: ubuntu-latest | ||
| timeout-minutes: 60 | ||
| steps: | ||
| - uses: CodeBoarding/CodeBoarding-action@v1 |
There was a problem hiding this comment.
Replace @v1 here and in codeboarding.yml with the action's full 40-character commit SHA and retain the release tag as a comment. The mutable tag lets an upstream retag or compromise execute new code with contents: write and OIDC access on every main push; the review workflow similarly grants pull-request and issue write access.
AGENTS.md reference: AGENTS.md:L588-L588
Useful? React with 👍 / 👎.
| with: | ||
| mode: sync | ||
| force_full: ${{ inputs.force_full || false }} | ||
| target_branch: 'main' |
There was a problem hiding this comment.
Configure sync_strategy: pull_request instead of targeting main with the default direct-push strategy, and grant pull-requests: write. This repository documents required checks and a merge queue on main in docs/decisions/0073-single-stable-branch-with-automatic-ports.md:51, so the workflow token cannot normally deliver its generated commit directly and the baseline will never update. CodeBoarding's protected-branch instructions prescribe the pull-request strategy for this case.
Useful? React with 👍 / 👎.
| startsWith(github.event.comment.body, '/codeboarding') && | ||
| contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) | ||
| steps: | ||
| - uses: CodeBoarding/CodeBoarding-action@v1 |
There was a problem hiding this comment.
Do not let this action publish its hosted-LLM architecture analysis directly to pull requests. Every matching PR event currently generates and posts a comment without any contributor reviewing the output, contrary to the repository's explicit automated-agent policy; retain the analysis as an artifact or add a human approval and review stage before publication.
AGENTS.md reference: AGENTS.md:L84-L88
Useful? React with 👍 / 👎.
1 participant
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 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.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.