-
Notifications
You must be signed in to change notification settings - Fork 0
Add CodeBoarding architecture analysis #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
a305961
17f7414
7a70b20
000b358
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: CodeBoarding sync | ||
|
|
||
| on: | ||
| push: | ||
| branches: ['main'] | ||
| # Loop guard: don't re-trigger on the files this workflow itself commits. | ||
| # List generated files only: user-authored scope configuration must still trigger | ||
| # regeneration, while a merged sync PR must not trigger a loop. | ||
| paths-ignore: | ||
| - '.codeboarding/*.md' | ||
| - '.codeboarding/analysis.json' | ||
| - '.codeboarding/fingerprint.json' | ||
| - '.codeboarding/static_analysis.pkl' | ||
| - '.codeboarding/static_analysis.sha' | ||
| - '.codeboarding/codeboarding_version.json' | ||
| - '.codeboarding/health/health_report.json' | ||
| - 'docs/development/architecture.md' | ||
| workflow_dispatch: | ||
| inputs: | ||
| force_full: | ||
| description: 'Ignore the committed baseline and rebuild it from scratch (full analysis).' | ||
| type: boolean | ||
| required: false | ||
| default: false | ||
|
|
||
| permissions: | ||
| contents: write # commit the generated baseline + docs to the branch | ||
| id-token: write # identifies this repo to CodeBoarding's hosted tier — used by the free | ||
| # tier AND a license, and as the fallback until your own key exists | ||
|
|
||
| concurrency: | ||
| # Serialize against itself so a push landing mid-run can't make two commits. | ||
| group: codeboarding-sync | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| sync: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 60 | ||
| steps: | ||
| - uses: CodeBoarding/CodeBoarding-action@refs/pull/70/head | ||
| with: | ||
| mode: sync | ||
| force_full: ${{ inputs.force_full || false }} | ||
| target_branch: 'main' | ||
| # Free tier needs no secret — these fall through to the hosted OIDC tier when | ||
| # unset. Add either repo secret (Settings → Secrets and variables → Actions) | ||
| # for more/unmetered usage; no YAML edit required. | ||
| llm_api_key: ${{ secrets.OPENROUTER_API_KEY }} # BYO LLM provider key (OpenRouter) | ||
| license_key: ${{ secrets.CODEBOARDING_LICENSE }} # CodeBoarding paid plan |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: CodeBoarding review | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, reopened, ready_for_review, closed] | ||
|
Comment on lines
+4
to
+5
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
For pull requests from forks, GitHub downgrades the Useful? React with 👍 / 👎. |
||
| issue_comment: | ||
| types: [created] | ||
|
|
||
| # No workflow-level permissions: each job requests only what it needs (least | ||
| # privilege), so the default token starts with none. | ||
| permissions: {} | ||
|
|
||
| concurrency: | ||
| group: codeboarding-${{ github.event.pull_request.number || github.event.issue.number }} | ||
| cancel-in-progress: ${{ github.event_name == 'pull_request' && github.event.action == 'closed' }} | ||
|
|
||
| jobs: | ||
| review: | ||
| runs-on: 32GB-runner | ||
| timeout-minutes: 60 | ||
| permissions: | ||
| contents: read # check out the repo + read the committed baseline (no writes in review mode) | ||
| pull-requests: write # post the architecture-diff PR comment | ||
| issues: write # the /codeboarding issue_comment trigger + comment API | ||
| id-token: write # mint a GitHub OIDC token for the free hosted tier (write is the only level for id-token) | ||
| if: > | ||
| (github.event_name == 'pull_request' && github.event.action != 'closed' && github.event.pull_request.draft == false) || | ||
| (github.event_name == 'issue_comment' && github.event.issue.pull_request != null && | ||
| startsWith(github.event.comment.body, '/codeboarding') && | ||
| contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) | ||
| steps: | ||
| - uses: CodeBoarding/CodeBoarding-action@v1 | ||
| with: | ||
| # Free tier needs no secret — these fall through to the hosted OIDC tier when | ||
| # unset. Add either repo secret (Settings → Secrets and variables → Actions) | ||
| # for more/unmetered usage; no YAML edit required. | ||
| llm_api_key: ${{ secrets.OPENROUTER_API_KEY }} # BYO LLM provider key (OpenRouter) | ||
| license_key: ${{ secrets.CODEBOARDING_LICENSE }} # CodeBoarding paid plan | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add
synchronizeto this activity list. As configured, the analysis runs when a PR is initially opened but not when additional commits are pushed, so its architecture-diff comment and artifact become stale for the common case where a PR changes during review. GitHub's pull-request event documentation definessynchronizeas the activity emitted when the PR head branch is updated.Useful? React with 👍 / 👎.