Skip to content

Add CodeBoarding architecture analysis - #1

Merged
ivanmilevtues merged 1 commit into
devfrom
codeboarding/setup-action
Oct 15, 2026
Merged

ivanmilevtues merged 1 commit into
devfrom
codeboarding/setup-action

Conversation

@ivanmilevtues

@ivanmilevtues ivanmilevtues commented Oct 15, 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 dev on pushes and manual runs.

Sync delivery

Sync saves the generated diagram on its own codeboarding/baseline branch in this repository; dev 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.

@github-actions

Copy link
Copy Markdown

Hey! Your PR title Add CodeBoarding architecture analysis doesn't follow conventional commit format.

Please update it to start with one of:

  • feat: or feat(scope): new feature
  • fix: or fix(scope): bug fix
  • docs: or docs(scope): documentation changes
  • chore: or chore(scope): maintenance tasks
  • refactor: or refactor(scope): code refactoring
  • test: or test(scope): adding or updating tests

Where scope is the package name (e.g., app, desktop, opencode).

See CONTRIBUTING.md for details.

@github-actions

Copy link
Copy Markdown

This PR doesn't fully meet our contributing guidelines and PR template.

What needs to be fixed:

  • PR description is missing required template sections. Please use the PR template.

Please edit this PR description to address the above within 72 hours, or it will be automatically closed.

If you believe this was flagged incorrectly, please let a maintainer know.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 15, 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-15T16:30:37.621796Z 8565876 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

Copy link
Copy Markdown

Hey! Your PR title Add CodeBoarding architecture analysis doesn't follow conventional commit format.

Please update it to start with one of:

  • feat: or feat(scope): new feature
  • fix: or fix(scope): bug fix
  • docs: or docs(scope): documentation changes
  • chore: or chore(scope): maintenance tasks
  • refactor: or refactor(scope): code refactoring
  • test: or test(scope): adding or updating tests

Where scope is the package name (e.g., app, desktop, opencode).

See CONTRIBUTING.md for details.

@github-actions

Copy link
Copy Markdown

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 38769127132 · attempt 1

@ivanmilevtues
ivanmilevtues merged commit 8365794 into dev Oct 15, 2026
6 of 13 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8565876343

ℹ️ 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".

actions: read # continue from an analysis an earlier run published
id-token: write # identifies this repo to CodeBoarding's hosted tier
steps:
- uses: CodeBoarding/CodeBoarding-action@v1

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Pin the privileged action to an immutable commit

If the mutable v1 tag is moved or the third-party action repository is compromised, the next push to dev executes unreviewed code with contents: write and id-token: write, allowing it to modify this repository or misuse the OIDC identity. GitHub identifies a full-length commit SHA as the immutable and most secure reference, and the repository's other workflows already follow that pattern; pin both CodeBoarding invocations to a verified SHA rather than @v1. GitHub secure-use guidance

Useful? React with 👍 / 👎.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant