Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/workflows/codeboarding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: CodeBoarding

on:
pull_request:
types: [opened, reopened, closed, synchronize]
issue_comment:
types: [created]
# Sync keeps one branch's analysis, so this lists exactly one. There is no manual
# trigger: a dispatch could run sync on any branch.
push:
branches: ['dev']

# No workflow-level permissions: each job requests only what it needs (least
# privilege), so the default token starts with none.
permissions: {}

# Reviews queue per pull request, syncs per branch. Closing a pull request cancels its review.
concurrency:
group: codeboarding-${{ github.event.pull_request.number || github.event.issue.number || github.ref_name }}
cancel-in-progress: ${{ github.event_name == 'pull_request' && github.event.action == 'closed' }}

jobs:
review:
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))
runs-on: ubuntu-latest
timeout-minutes: 60
permissions:
contents: read # check out the repo + read the saved analysis (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
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

sync:
if: github.event_name == 'push'
runs-on: ubuntu-latest
timeout-minutes: 60
permissions:
contents: write # push the generated analysis to codeboarding/baseline
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 👍 / 👎.

with:
mode: sync
# 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
Loading