-
Notifications
You must be signed in to change notification settings - Fork 1.3k
feat(examples): add workflow_dispatch example for on-demand Claude tasks #775
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
Open
ModeEric
wants to merge
2
commits into
anthropics:main
Choose a base branch
from
ModeEric:add-workflow-dispatch-example
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+57
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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,57 @@ | ||
| # Run Claude on-demand via GitHub UI or API | ||
| # | ||
| # This workflow lets you trigger Claude manually with any task. | ||
| # Useful for: | ||
| # - Running Claude without creating an issue | ||
| # - Triggering via API from external systems | ||
| # - Testing prompts before automating them | ||
| # | ||
| # Trigger via UI: Actions tab → "Run Claude Task" → "Run workflow" | ||
| # Trigger via API (requires a Personal Access Token, not GITHUB_TOKEN): | ||
| # curl -X POST \ | ||
| # -H "Authorization: Bearer $PAT" \ | ||
| # -H "Accept: application/vnd.github.v3+json" \ | ||
| # https://api.github.com/repos/OWNER/REPO/actions/workflows/workflow-dispatch.yml/dispatches \ | ||
| # -d '{"ref":"main","inputs":{"task":"Add tests for utils.ts"}}' | ||
|
|
||
| name: Run Claude Task | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| task: | ||
| description: "What should Claude do?" | ||
| required: true | ||
| type: string | ||
| issue_number: | ||
| description: "Optional: Reference an issue number for context" | ||
| required: false | ||
| type: string | ||
|
|
||
| jobs: | ||
| claude: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| issues: write | ||
| id-token: write | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Run Claude | ||
| uses: anthropics/claude-code-action@v1 | ||
| with: | ||
| anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| prompt: | | ||
| Repository: ${{ github.repository }} | ||
| Branch: ${{ github.ref_name }} | ||
| ${{ github.event.inputs.issue_number && format('Related Issue: #{0}', github.event.inputs.issue_number) || '' }} | ||
|
|
||
| Task: ${{ github.event.inputs.task }} | ||
| # Basic file operations - add more tools as needed (e.g., Bash commands) | ||
| claude_args: | | ||
| --allowedTools "Read,Write,Edit,MultiEdit,LS" | ||
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.
This is cool, should we also include some allowed tools to make this work out of the box a bit better?
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.
Yeah good idea! I ran into similar issues with testing, so I updated the PR to allow some basic file editing tools so it works out of the box.