Repository navigation
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| 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@v1 | ||
| with: | ||
| mode: sync | ||
| force_full: ${{ inputs.force_full || false }} | ||
| target_branch: 'main' | ||
| # CodeBoarding's free hosted tier. No secret to add: the run authenticates | ||
| # with the GitHub OIDC token that `id-token: write` above grants. | ||
| llm: hosted | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: CodeBoarding review | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, reopened, closed, synchronize] | ||
| 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: ubuntu-latest | ||
| 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) | ||
| actions: read # let a repeat review download the analysis an earlier run published, instead of re-deriving the whole PR | ||
| if: > | ||
| (github.event_name == 'pull_request' && github.event.action != 'closed' && | ||
| github.event.pull_request.head.repo.full_name == github.repository) || | ||
| (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: | ||
| # CodeBoarding's free hosted tier. No secret to add: the run authenticates | ||
| # with the GitHub OIDC token that `id-token: write` above grants. | ||
| llm: hosted |
Oops, something went wrong.
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.
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.
Both new workflows reference the mutable
@v1tag, so an upstream retag or compromise can replace the code executed withcontents: write,id-token: write, and PR/issue write permissions without any reviewed repository change. Replace this reference and the identical one incodeboarding.ymlwith the verified 40-character release SHA and retain the version tag as a trailing comment.AGENTS.md reference: AGENTS.md:L579-L579
Useful? React with 👍 / 👎.