Add CodeBoarding architecture analysis - #1
Open
ivanmilevtues wants to merge 2 commits into
Open
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. run 34062030568 · attempt 1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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. Re-run setup from your
CodeBoarding dashboard and pick:
others.
That opens a second pull request with the one-line change, and tells you which secret to
add under Settings → Secrets and variables → Actions.
Opened for you by CodeBoarding.