-
Notifications
You must be signed in to change notification settings - Fork 0
Add DeepWork Review GitHub Action #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
Show all changes
8 commits
Select commit
Hold shift + click to select a range
4b26b33
Initial plan
Copilot f4aa54a
Add DeepWork Review GitHub Action
Copilot 5c3552d
Remove accidentally committed __pycache__ files
Copilot 654752c
Use Node 24 + setup-node@v6, add .deepwork/tmp cache per PR
Copilot bc66f07
Use anthropics/claude-code-base-action; proper plugin install; remove…
Copilot c682810
Apply suggestion from @nhorton
nhorton f1a5126
Update model to claude-opus-4-6; replace [skip ci] with bot identity …
Copilot 1290b16
Simplify pull_request trigger types: drop reopened, keep opened+synch…
Copilot 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,41 @@ | ||
| name: DeepWork Review | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize] | ||
|
|
||
| # Prevent concurrent runs on the same PR | ||
| concurrency: | ||
| group: deepwork-review-${{ github.event.pull_request.number }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| deepwork-review: | ||
| runs-on: ubuntu-latest | ||
| # Don't re-run on commits pushed by the action itself | ||
| if: github.actor != 'deepwork-action[bot]' | ||
| # Required permissions | ||
| permissions: | ||
| contents: write # push auto-fix commits to the PR branch | ||
| pull-requests: write # post inline PR review comments | ||
|
|
||
| steps: | ||
| - name: Checkout PR branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| # Fetch full history so DeepWork can diff against the base branch | ||
| # Set too `100` or something high but safe if you have a huge git history | ||
| fetch-depth: 0 | ||
| # Use the merge ref so we operate on the PR's head commit | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Run DeepWork Review | ||
| uses: Unsupervisedcom/deepwork-action@v1 | ||
| with: | ||
| anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| # Optional overrides: | ||
| # model: claude-opus-4-6 | ||
| # max_turns: '50' | ||
| # commit_message: 'chore: apply DeepWork review suggestions' | ||
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 @@ | ||
| scripts/__pycache__/ |
nhorton marked this conversation as resolved.
Show resolved
Hide resolved
|
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 |
|---|---|---|
| @@ -1,2 +1,96 @@ | ||
| # deepwork-action | ||
| DeepWork GitHub Action | ||
|
|
||
| A prebuilt GitHub Action that runs [Claude Code](https://docs.anthropic.com/en/docs/claude-code) on a Pull Request with the [DeepWork](https://github.com/Unsupervisedcom/deepwork) plugin installed, triggers the `/review` skill, auto-commits all review-driven improvements back to the PR branch, and posts inline PR review comments explaining each change. | ||
|
|
||
| ## How It Works | ||
|
|
||
| 1. **DeepWork plugin install** — The action installs the DeepWork plugin from the marketplace using Claude Code's native plugin system, loading all review skills, hooks, and MCP server configuration automatically. | ||
| 2. **DeepWork review** — Claude Code runs the `/review` skill, which reads your `.deepreview` config files to discover review rules, diffs the PR branch, and dispatches parallel review agents scoped to exactly the right files. | ||
| 3. **Apply changes** — Claude applies every suggested improvement (bugs, style, performance, security, docs, refactoring) without asking for confirmation. | ||
| 4. **Auto-commit** — All file changes are committed back to the PR branch under the `deepwork-action[bot]` identity. | ||
| 5. **Inline PR comments** — A GitHub PR review is posted with one inline comment per changed file, describing what was changed and why, so your team can review each improvement. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. **Anthropic API key** — add it as a repository secret named `ANTHROPIC_API_KEY`. | ||
| 2. **`.deepreview` configuration** — place one or more `.deepreview` files in your repository defining your review rules. See the [DeepWork Reviews documentation](https://github.com/Unsupervisedcom/deepwork/blob/main/README_REVIEWS.md) for details. | ||
|
|
||
| ## Usage | ||
|
|
||
| Create a workflow file such as `.github/workflows/deepwork-review.yml`: | ||
|
|
||
| ```yaml | ||
| name: DeepWork Review | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize] | ||
|
|
||
| concurrency: | ||
| group: deepwork-review-${{ github.event.pull_request.number }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| deepwork-review: | ||
| runs-on: ubuntu-latest | ||
| # Don't re-run on commits pushed by the action itself | ||
| if: github.actor != 'deepwork-action[bot]' | ||
| permissions: | ||
| contents: write # push auto-fix commits to the PR branch | ||
| pull-requests: write # post inline PR review comments | ||
|
|
||
| steps: | ||
| - name: Checkout PR branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Run DeepWork Review | ||
| uses: Unsupervisedcom/deepwork-action@v1 | ||
| with: | ||
| anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| ``` | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Input | Required | Default | Description | | ||
| |-------|----------|---------|-------------| | ||
| | `anthropic_api_key` | ✅ | — | Anthropic API key for Claude Code | | ||
| | `github_token` | ✅ | — | GitHub token with `contents: write` and `pull-requests: write` | | ||
| | `model` | ❌ | `claude-opus-4-6` | Claude model to use | | ||
| | `max_turns` | ❌ | `50` | Maximum agentic turns for Claude Code | | ||
| | `commit_message` | ❌ | `chore: apply DeepWork review suggestions` | Commit message for auto-committed changes | | ||
|
|
||
| ## What Gets Changed | ||
|
|
||
| The action applies **all** suggestions from your `.deepreview` rules, including: | ||
|
|
||
| - Bug fixes and null-safety checks | ||
| - Style and formatting improvements | ||
| - Performance optimisations | ||
| - Security hardening | ||
| - Documentation updates | ||
| - Refactoring suggestions | ||
|
|
||
| If no `.deepreview` rules are configured in the repository, the action exits cleanly without making any changes or commits. | ||
|
|
||
| ## Review Comments | ||
|
|
||
| After pushing the auto-fix commit, the action posts a GitHub PR review with inline comments on each changed file. The comments appear in the **Files Changed** tab and describe what was changed and why, so your team can accept, request modifications, or revert individual changes as needed. | ||
|
|
||
| ## Caching | ||
|
|
||
| Review state is cached per PR using GitHub Actions cache, keyed on the PR number. This means already-passed reviews are not re-run when you push new commits to the same PR — only code that has changed since the last review is re-evaluated. THIS IS A MAJOR TOKEN COST SAVER!!! | ||
|
|
||
| ## Security | ||
|
|
||
| - Claude Code is installed and run via the official [`anthropics/claude-code-base-action`](https://github.com/anthropics/claude-code-base-action). | ||
| - The action runs with `--dangerously-skip-permissions` in a sandboxed GitHub Actions runner. It has no access to secrets beyond what you explicitly provide. | ||
| - Auto-fix commits are pushed under the `deepwork-action[bot]` identity. The example workflow includes `if: github.actor != 'deepwork-action[bot]'` at the job level so the action never triggers itself recursively. | ||
|
|
||
| ## License | ||
|
|
||
| See [LICENSE](LICENSE). |
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,114 @@ | ||
| name: 'DeepWork Review Action' | ||
| description: 'Run DeepWork reviews via Claude Code on a PR, auto-commit improvements, and add inline PR review comments' | ||
| author: 'Unsupervisedcom' | ||
|
|
||
| branding: | ||
| icon: 'check-circle' | ||
| color: 'blue' | ||
|
|
||
| inputs: | ||
| anthropic_api_key: | ||
| description: 'Anthropic API key for Claude Code' | ||
| required: true | ||
| github_token: | ||
| description: 'GitHub token with write access to commit changes and post review comments' | ||
| required: true | ||
| model: | ||
| description: 'Claude model to use (e.g. claude-sonnet-4-6, claude-opus-4-6)' | ||
| required: false | ||
| default: 'claude-opus-4-6' | ||
| max_turns: | ||
| description: 'Maximum number of agentic turns for Claude Code' | ||
| required: false | ||
| default: '50' | ||
| commit_message: | ||
| description: 'Commit message for auto-committed review changes' | ||
| required: false | ||
| default: 'chore: apply DeepWork review suggestions' | ||
|
|
||
| runs: | ||
| using: 'composite' | ||
| steps: | ||
| - name: Install uv | ||
| uses: astral-sh/setup-uv@v5 | ||
| with: | ||
| version: 'latest' | ||
|
|
||
| - name: Restore DeepWork review cache | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: .deepwork/tmp | ||
| # A unique save key per run ensures the cache is always updated with the | ||
| # latest review state after each run. restore-keys picks up the most recent | ||
| # cache for this PR so already-passed reviews are not re-run. | ||
| key: deepwork-review-pr-${{ github.event.pull_request.number }}-${{ github.run_id }} | ||
| restore-keys: | | ||
| deepwork-review-pr-${{ github.event.pull_request.number }}- | ||
|
|
||
| - name: Fetch base branch for git diff | ||
| shell: bash | ||
| run: | | ||
| BASE_REF="${{ github.event.pull_request.base.ref }}" | ||
| if [ -n "$BASE_REF" ]; then | ||
| git fetch origin "$BASE_REF" --depth=1 || \ | ||
| echo "Warning: could not fetch base branch '$BASE_REF'; diff detection may be incomplete" | ||
| fi | ||
|
|
||
| - name: Prepare review run | ||
| shell: bash | ||
| run: | | ||
| # Clean up any leftover changes file from a previous run. | ||
| rm -f /tmp/deepwork_changes.json | ||
|
|
||
| - name: Run DeepWork review with Claude Code | ||
| uses: anthropics/claude-code-base-action@beta | ||
| env: | ||
| GH_TOKEN: ${{ inputs.github_token }} | ||
| with: | ||
| anthropic_api_key: ${{ inputs.anthropic_api_key }} | ||
| prompt_file: ${{ github.action_path }}/prompts/review.txt | ||
| plugin_marketplaces: https://github.com/Unsupervisedcom/deepwork.git | ||
| plugins: deepwork@deepwork-plugins | ||
| claude_args: >- | ||
| --dangerously-skip-permissions | ||
| --model ${{ inputs.model }} | ||
| --max-turns ${{ inputs.max_turns }} | ||
|
|
||
| - name: Commit and push changes | ||
| id: commit | ||
| shell: bash | ||
| env: | ||
| GITHUB_TOKEN: ${{ inputs.github_token }} | ||
| run: | | ||
| git config user.name "deepwork-action[bot]" | ||
| git config user.email "deepwork-action[bot]@users.noreply.github.com" | ||
|
|
||
| # Check for any modified, added, or deleted tracked files | ||
| if git diff --quiet && git diff --cached --quiet \ | ||
| && [ -z "$(git ls-files --others --exclude-standard)" ]; then | ||
| echo "No changes to commit." | ||
| echo "changes_made=false" >> "$GITHUB_OUTPUT" | ||
| exit 0 | ||
| fi | ||
|
|
||
| echo "changes_made=true" >> "$GITHUB_OUTPUT" | ||
|
|
||
| git add -A | ||
| git commit -m "${{ inputs.commit_message }}" | ||
|
|
||
| # Authenticate push via the provided token. | ||
| REPO="${{ github.repository }}" | ||
| git remote set-url origin \ | ||
| "https://x-access-token:${GITHUB_TOKEN}@github.com/${REPO}.git" | ||
| git push | ||
|
|
||
| - name: Post inline PR review comments | ||
| if: steps.commit.outputs.changes_made == 'true' && github.event.pull_request.number != '' | ||
| shell: bash | ||
| env: | ||
| GH_TOKEN: ${{ inputs.github_token }} | ||
| PR_NUMBER: ${{ github.event.pull_request.number }} | ||
| GITHUB_REPOSITORY: ${{ github.repository }} | ||
| GITHUB_BASE_REF: ${{ github.event.pull_request.base.ref }} | ||
| run: | | ||
| python3 "${{ github.action_path }}/scripts/post-review-comments.py" |
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 @@ | ||
| /review | ||
|
|
||
| You are running in a fully automated CI environment on a GitHub Pull Request. | ||
| There is NO human watching this session. Follow these critical rules at all times: | ||
|
|
||
| ## Automation Rules (MANDATORY) | ||
|
|
||
| 1. **NEVER use AskUserQuestion** — you are in CI mode; make every decision autonomously. | ||
| 2. **Make ALL changes** suggested by the review findings — not just "obviously good" ones. | ||
| Apply every finding: bugs, style, performance, security, documentation, and refactoring. | ||
| When a finding offers multiple approaches, choose the best one yourself. | ||
| 3. **Iterate** — after making changes, re-run the review until it comes back clean. | ||
| 4. **If no `.deepreview` rules are configured** — output the message "No review rules configured." | ||
| and stop. Do not attempt to configure rules; that is the repository owner's responsibility. | ||
|
|
||
| ## Change Tracking (REQUIRED) | ||
|
|
||
| For every file you modify, append an entry to `/tmp/deepwork_changes.json`. | ||
| Create the file with `{"changes": []}` if it does not yet exist. | ||
|
|
||
| Each entry must follow this exact JSON structure: | ||
|
|
||
| ```json | ||
| { | ||
| "file": "relative/path/to/changed/file", | ||
| "line": <line_number_where_main_change_was_made>, | ||
| "description": "One-sentence description of what was changed", | ||
| "reason": "The review finding that prompted this change" | ||
| } | ||
| ``` | ||
|
|
||
| Write the final file when all changes are complete and the review passes. | ||
|
|
||
| ## Important | ||
|
|
||
| - You have full permission to edit, create, and delete files in this repository. | ||
| - Do NOT commit changes yourself — the CI workflow handles git commit and push. | ||
| - Do NOT push changes yourself — the CI workflow handles git commit and push. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.