Repository navigation
feat(scenarios): add Velocity support - state templates #50
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: feat/scenarios/override/velocity-support
Are you sure you want to change the base?
Changes from 2 commits
48a4685
319335f
ba50432
467c698
b807bfe
25bc1b5
be444ef
fb68145
187ebb6
42fa047
3aae662
0ff3610
4f8f3b6
dfeec60
bf9949d
f713474
757eb4e
26f1c82
871423a
8a13065
384dff0
bc02a4d
930665c
3952bf1
4de1498
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,141 @@ | ||
| name: Perform a code review when a pull request is created. | ||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
|
|
||
| jobs: | ||
| claude: | ||
| # Skip drafts, and skip fork PRs: on `pull_request` they don't get the | ||
| # ANTHROPIC_API_KEY secret, so the review would only fail. | ||
| if: >- | ||
| !github.event.pull_request.draft && | ||
| github.event.pull_request.head.repo.full_name == github.repository | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| outputs: | ||
| structured_output: ${{ steps.run_claude.outputs.structured_output }} | ||
| steps: | ||
| - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5.1.0 | ||
| with: | ||
| # Explicitly check out the PR's merge commit. | ||
| ref: refs/pull/${{ github.event.pull_request.number }}/merge | ||
| persist-credentials: false | ||
|
|
||
| - name: Pre-fetch base and head refs for the PR | ||
| env: | ||
| PR_BASE_REF: ${{ github.event.pull_request.base.ref }} | ||
| PR_NUMBER: ${{ github.event.pull_request.number }} | ||
| run: | | ||
| # Pass GitHub expressions through env and quote shell expansions. | ||
| git fetch --no-tags origin \ | ||
| "$PR_BASE_REF" \ | ||
| "+refs/pull/$PR_NUMBER/head" | ||
|
|
||
| # If you want Claude to build and run code, install any dependencies that | ||
| # need to be downloaded before the "Run Claude" step, and add the commands | ||
| # it may run to --allowedTools below (e.g. "Bash(npm test:*)"). Any tool | ||
| # not listed there is denied. | ||
|
|
||
| - name: Run Claude | ||
| id: run_claude | ||
| uses: anthropics/claude-code-action@86d88e619d8e6caf07b5c3944dd14f441c533718 # v1.0.243 | ||
| with: | ||
| anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} | ||
| # Use this job's read-only token instead of the Claude GitHub App, | ||
| # which needs `id-token: write` and would get write access. | ||
| github_token: ${{ github.token }} | ||
| prompt: | | ||
| This is PR #${{ github.event.pull_request.number }} for ${{ github.repository }}. | ||
|
|
||
| Review ONLY the changes introduced by the PR, so consider: | ||
| git log --oneline ${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }} | ||
| git diff ${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }} | ||
|
|
||
| Suggest any improvements, potential bugs, or issues. | ||
| Be concise and specific in your feedback. | ||
|
|
||
| Return your review in two parts: | ||
| - `summary`: a short Markdown overview of the PR and your overall assessment. | ||
| - `comments`: one entry per specific issue, anchored to the line it concerns. | ||
| `path` is relative to the repository root. `line` is the line number in | ||
| the PR head version of the file (${{ github.event.pull_request.head.sha }}), | ||
| and must be a line shown in the diff above. The working tree is the merge | ||
| commit, so its line numbers can differ; check them with | ||
| `git show ${{ github.event.pull_request.head.sha }}:<path>`. | ||
| Put issues that don't belong to a single line in `summary` instead. | ||
|
|
||
| Pull request title and body: | ||
| ---- | ||
| ${{ github.event.pull_request.title }} | ||
| ${{ github.event.pull_request.body }} | ||
|
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. This CI workflow has nothing to do with Velocity support; please move it into its own PR. Also, the PR title and body go into the prompt unescaped. The tool allowlist is read-only and fork PRs are skipped, so the risk is limited, but any same-repo author can steer the review output that |
||
| claude_args: | | ||
| --allowedTools "Read,Grep,Glob,Bash(git log:*),Bash(git diff:*),Bash(git show:*)" | ||
| --json-schema '{ | ||
| "type": "object", | ||
| "properties": { | ||
| "summary": { | ||
| "type": "string", | ||
| "description": "Overall review as Markdown, posted as the review body." | ||
| }, | ||
| "comments": { | ||
| "type": "array", | ||
| "description": "Inline comments, each anchored to one line of the PR diff.", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "path": { "type": "string", "description": "File path relative to the repository root." }, | ||
| "line": { "type": "integer", "minimum": 1, "description": "Line number in the PR head version of the file. Must be within the diff." }, | ||
| "body": { "type": "string", "description": "The comment, as Markdown." } | ||
| }, | ||
| "required": ["path", "line", "body"] | ||
| } | ||
| } | ||
| }, | ||
| "required": ["summary", "comments"] | ||
| }' | ||
|
|
||
| post_feedback: | ||
| runs-on: ubuntu-latest | ||
| needs: claude | ||
| if: needs.claude.outputs.structured_output != '' | ||
| permissions: | ||
| issues: write | ||
| pull-requests: write | ||
| steps: | ||
| - name: Report Claude feedback | ||
| uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0 | ||
| env: | ||
| CLAUDE_STRUCTURED_OUTPUT: ${{ needs.claude.outputs.structured_output }} | ||
| with: | ||
| github-token: ${{ github.token }} | ||
| script: | | ||
| const { summary = '', comments = [] } = JSON.parse(process.env.CLAUDE_STRUCTURED_OUTPUT); | ||
| const pr = context.payload.pull_request; | ||
| if (!summary.trim() && comments.length === 0) { | ||
| core.info('Claude returned an empty review; nothing to post.'); | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| await github.rest.pulls.createReview({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| pull_number: pr.number, | ||
| commit_id: pr.head.sha, | ||
| event: 'COMMENT', | ||
| body: summary.trim() || 'See inline comments.', | ||
| comments: comments.map(({ path, line, body }) => ({ path, line, side: 'RIGHT', body })), | ||
| }); | ||
| } catch (error) { | ||
| // GitHub rejects the whole review if any comment points outside the | ||
| // diff. Fall back to a single PR comment so no feedback is lost. | ||
| core.warning(`Could not post inline review (${error.message}); posting a plain comment instead.`); | ||
| const details = comments.map(({ path, line, body }) => `**\`${path}:${line}\`**\n\n${body}`); | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: pr.number, | ||
| body: [summary.trim(), ...details].filter(Boolean).join('\n\n---\n\n'), | ||
| }); | ||
| } | ||
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.
This new CI workflow is out of scope for a Velocity templates PR. It needs
ANTHROPIC_API_KEYand has a job withpull-requests: write. Please submit it in a separate PR so maintainers can review it on its own.