Skip to content

Add CodeBoarding architecture analysis - #2

Open
ivanmilevtues wants to merge 1 commit into
mainfrom
codeboarding/setup-action
Open

ivanmilevtues wants to merge 1 commit into
mainfrom
codeboarding/setup-action

Conversation

@ivanmilevtues

@ivanmilevtues ivanmilevtues commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Preview first, merge when ready

View your map · Configure & merge

The preview runs on this pull request. Merge the workflow to keep maps updated. Settings can be changed in this same pull request before merging.

This PR adds CodeBoarding in one workflow file, codeboarding.yml, with two jobs:

  • review keeps an architecture-diff comment current on pull requests and publishes their diagrams for the viewer.
  • sync saves the diagram of main on pushes and manual runs.

Sync delivery

Sync saves the generated diagram on its own codeboarding/baseline branch in this repository; main never changes and there is nothing to merge.

Protect codeboarding/baseline

Sync and review load a Python pickle from that branch, and loading a pickle runs code, so anyone
who can push to it can run code in these workflows. Import a ruleset under Settings, Rules,
Rulesets, New ruleset, Import a ruleset, before the first sync:

  • baseline-branch-ruleset-actions.json fits this workflow
    as generated, which pushes with the default github.token. It stops people pushing by hand,
    but any workflow with contents: write can still write the branch.
  • baseline-branch-ruleset.json lets only the CodeBoarding Review app
    write it. Use it when sync pushes with the app's token as github_token.

More in the baseline branch. Rulesets on a private
repository need a paid GitHub plan.

Works out of the box

Just merge it: the Action runs on the free tier, with no secret to add. The
id-token: write permission 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 this workflow file rather than a secret you add, because the
file names which credentials a run uses. Use Configure & merge in the viewer to pick:

  • a CodeBoarding plan (unmetered, and raises the analysis-depth ceiling from 3 to 10), or
  • your own provider key: OpenRouter, Anthropic, OpenAI, Google, AWS Bedrock and
    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.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-26T11:11:11.489507Z ad1dee8 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

CodeBoarding review · analyzing…

  1. ⏳ Building the diagram of main @2bdd1d6 from scratch
    main has no saved diagram this review can start from, so it builds one first. Once a diagram of main is saved, reviews start from it and skip this step.
  2. Analysing this PR's changes

Open it in CodeBoarding meanwhile: the files, comments and review are there already, and the diff appears when the run finishes.

run 40313003871 · attempt 1

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