Skip to content

Add CodeBoarding architecture analysis#40

Open
Svilen-Stefanov wants to merge 2 commits into
mainfrom
codeboarding/setup-action
Open

Add CodeBoarding architecture analysis#40
Svilen-Stefanov wants to merge 2 commits into
mainfrom
codeboarding/setup-action

Conversation

@Svilen-Stefanov

Copy link
Copy Markdown
Contributor

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 is
    what the CodeBoarding viewer opens.
  • codeboarding.yml — on every pull request, posts an architecture-diff comment and
    uploads 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: write permission lets it identify your repo to CodeBoarding’s hosted LLM,
metered per account against a weekly limit.

Want more, or unmetered, usage?

Add an LLM provider key — OpenRouter (OPENROUTER_API_KEY), Anthropic, OpenAI, Google,
AWS Bedrock, etc. — or a CODEBOARDING_LICENSE, as a repository secret under
Settings → Secrets and variables → Actions, then pass it to the action via llm_api_key
(+ llm_provider) or license_key. See the
provider list. Optional —
the free tier needs nothing.

— opened for you by CodeBoarding

@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Architecture review · free tier limit reached

This repository owner's free weekly CodeBoarding usage is used up, so the architecture diff couldn't be generated. It resets at the start of next week.

For more (or unmetered) usage, add one of these repository secrets and pass it to the action:

  • OPENROUTER_API_KEY — your own OpenRouter key, passed via the action's llm_api_key input, or
  • CODEBOARDING_LICENSE — a CodeBoarding license, passed via the action's license_key input.

See the setup guide for the exact workflow snippet.

codeboarding-action · run 27678302444

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant