Add CodeBoarding architecture analysis#1
Merged
Conversation
Architecture review · analyzing…⏳ CodeBoarding is analyzing the architecture changes in this PR. This usually takes a few minutes. codeboarding-action · run 29347746331 |
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 to your default branch, 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.
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 per account against a weekly limit.
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).For a non-OpenRouter provider (Anthropic, OpenAI, Google, AWS Bedrock, …) see the
provider list. Both are
optional — leave them unset and the free tier runs with nothing configured.
— opened for you by CodeBoarding