- Notifications
You must be signed in to change notification settings - Fork1.1k
docs: add GitHub to Coder Task Workflow Guide#20928
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
david-fraley wants to merge14 commits intomainChoose a base branch
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.
+265 −0
Open
Changes fromall commits
Commits
Show all changes
14 commits Select commitHold shift + click to select a range
26129d9 docs: GitHub to Coder Task Workflow Guide
david-fraleyd78c6ba docs: add 'the' before 'context' per review feedback
blink-so[bot]e399c85 addres gh cli stuff
david-fraleyf31c3fe minor typos
david-fraleya59292e linting fixes
david-fraley84faa7f i hate spacing
david-fraley7628f5f Update docs/ai-coder/github-to-tasks.md
david-fraleya1824f0 Update docs/ai-coder/github-to-tasks.md
david-fraley7b35d1e Update docs/ai-coder/github-to-tasks.md
david-fraleyf781eed Update docs/ai-coder/github-to-tasks.md
david-fraley5e368e6 Update docs/ai-coder/github-to-tasks.md
david-fraleyc97081a Update docs/ai-coder/github-to-tasks.md
david-fraley8b057c6 Update docs/ai-coder/github-to-tasks.md
david-fraley827ff69 Update docs/ai-coder/github-to-tasks.md
david-fraleyFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
259 changes: 259 additions & 0 deletionsdocs/ai-coder/github-to-tasks.md
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,259 @@ | ||
| # Guide: Create a GitHub to Coder Tasks Workflow | ||
| ## Background | ||
| Most software engineering organizations track and manage their codebase through GitHub, and use project management tools like Asana, Jira, or even GitHub's Projects to coordinate work. Across these systems, engineers are frequently performing the same repetitive workflows: triaging and addressing bugs, updating documentation, or implementing well-defined changes for example. | ||
| Coder Tasks provides a method for automating these repeatable workflows. With a Task, you can direct an agent like Claude Code to update your documentation or even diagnose and address a bug. By connecting GitHub to Coder Tasks, you can build out a GitHub workflow that will for example: | ||
| 1. Trigger an automation to take a pre-existing issue | ||
| 1. Automatically spin up a Coder Task with the context from that issue and direct an agent to work on it | ||
| 1. Focus on other higher-priority needs, while the agent addresses the issue | ||
| 1. Get notified that the issue has been addressed, and you can review the proposed solution | ||
| This guide walks you through how to configure GitHub and Coder together so that you can tag Coder in a GitHub issue comment, and securely delegate work to coding agents in a Coder Task. | ||
| ## Implementing the GHA | ||
| The below steps outline how to use the Coder [Create Task Action GHA](https://github.com/coder/create-task-action) in a GitHub workflow to solve a bug. The guide makes the following assumptions: | ||
| - You have access to a Coder Server that is running. If you don't have a Coder Server running, follow our [Quickstart Guide](https://coder.com/docs/tutorials/quickstart) | ||
| - Your Coder Server is accessible from GitHub | ||
| - You have an AI-enabled Task Template that can successfully create a Coder Task. If you don't have a Task Template available, follow our [Getting Started with Tasks Guide](https://coder.com/docs/ai-coder/tasks#getting-started-with-tasks) | ||
| - Check the [Requirements section of the GHA](https://github.com/coder/create-task-action?tab=readme-ov-file#requirements) for specific version requirements for your Coder deployment and the following | ||
| - GitHub OAuth is configured in your Coder Deployment | ||
| - Users have linked their GitHub account to Coder via `/settings/external-auth` | ||
| This guide can be followed for other use cases beyond bugs like updating documentation or implementing a small feature, but may require minor changes to file names and the prompts provided to the Coder Task. | ||
| ### Step 1: Create a GitHub Workflow file | ||
| In your repository, create a new file in the `./.github/workflows/` directory named `triage-bug.yaml`. Within that file, add the following code: | ||
| ```yaml | ||
| name: Start Coder Task | ||
| on: | ||
| issues: | ||
| types: | ||
| - labeled | ||
| permissions: | ||
| issues: write | ||
| jobs: | ||
| coder-create-task: | ||
| runs-on: ubuntu-latest | ||
| if: github.event.label.name == 'coder' | ||
| steps: | ||
| - name: Coder Create Task | ||
| uses: coder/create-task-action@v0 | ||
| with: | ||
| coder-url: ${{ secrets.CODER_URL }} | ||
| coder-token: ${{ secrets.CODER_TOKEN }} | ||
| coder-organization: "default" | ||
| coder-template-name: "my-template" | ||
| coder-task-name-prefix: "gh-task" | ||
| coder-task-prompt: "Use the gh CLI to read ${{ github.event.issue.html_url }}, write an appropriate plan for solving the issue to PLAN.md, and then wait for feedback." | ||
| github-user-id: ${{ github.event.sender.id }} | ||
| github-issue-url: ${{ github.event.issue.html_url }} | ||
| github-token: ${{ github.token }} | ||
| comment-on-issue: true | ||
| ``` | ||
| This code will perform the following actions: | ||
| - Create a Coder Task when you apply the `coder` label to an existing GitHub issue | ||
| - Pass as a prompt to the Coder Task: | ||
| 1. Use the GitHub CLI to access and read the content of the linked GitHub issue | ||
| 1. Generate an initial implementation plan to solve the bug | ||
| 1. Write that plan to a `PLAN.md` file | ||
| 1. Wait for additional input | ||
| - Post an update on the GitHub ticket with a link to the task | ||
| The prompt text can be modified to not wait for additional human input, but continue with implementing the proposed solution and creating a PR for example. Note that this example prompt uses the GitHub CLI `gh`, which must be installed in your Coder template. The CLI will automatically authenticate using the user's linked GitHub account via Coder's external auth. | ||
| ### Step 2: Setup the Required Secrets & Inputs | ||
| The GHA has multiple required inputs that require configuring before the workflow can successfully operate. | ||
| You must set the following inputs as secrets within your repository: | ||
| - `coder-url`: the URL of your Coder deployment, e.g. https://coder.example.com | ||
| - `coder-token`: follow our [API Tokens documentation](https://coder.com/docs/admin/users/sessions-tokens#long-lived-tokens-api-tokens) to generate a token. Note that the token must be an admin/org-level with the "Read users in organization" and "Create tasks for any user" permissions | ||
| You must also set `coder-template-name` as part of this. The GHA example has this listed as a secret, but the value doesn't need to be stored as a secret. The template name can be determined the following ways: | ||
| - By viewing the URL of the template in the UI, e.g. `https://<your-coder-url>/templates/<org-name>/<template-name>` | ||
| - Using the Coder CLI: | ||
| ```bash | ||
| # List all templates in your organization | ||
| coder templates list | ||
| # List templates in a specific organization | ||
| coder templates list --org your-org-name | ||
| ``` | ||
| You can also choose to modify the other [input parameters](https://github.com/coder/create-task-action?tab=readme-ov-file#inputs) to better fit your desired workflow. | ||
| #### Template Requirements for GitHub CLI | ||
| If your prompt uses the GitHub CLI `gh`, your template must pass the user's GitHub token to the agent. Add this to your template's Terraform: | ||
| ```terraform | ||
| data "coder_external_auth" "github" { | ||
| id = "github" # Must match your CODER_EXTERNAL_AUTH_0_ID | ||
| } | ||
| resource "coder_agent" "dev" { | ||
| # ... other config ... | ||
| env = { | ||
| GITHUB_TOKEN = data.coder_external_auth.github.access_token | ||
| } | ||
| } | ||
| ``` | ||
| Note that tokens passed as environment variables represent a snapshot at task creation time and are not automatically refreshed during task execution. | ||
| - If your GitHub external auth is configured as a GitHub App with token expiration enabled (the default), tokens expire after 8 hours | ||
| - If configured as a GitHub OAuth App or GitHub App with expiration disabled, tokens remain valid unless unused for 1 year | ||
| Because of this, we recommend to: | ||
| - Keep tasks under 8 hours to avoid token expiration issues | ||
| - For longer workflows, break work into multiple sequential tasks | ||
| - If authentication fails mid-task, users must re-authenticate at /settings/external-auth and restart the task | ||
| For more information, see our [External Authentication documentation](https://coder.com/docs/admin/external-auth#configure-a-github-oauth-app). | ||
| ### Step 3: Test Your Setup | ||
| Create a new GitHub issue for a bug in your codebase. We recommend a basic bug, for this test, like “The sidebar color needs to be red” or “The text ‘Coder Tasks are Awesome’ needs to appear in the top left corner of the screen”. You should adapt the phrasing to be specific to your codebase. | ||
| Add the `coder` label to that GitHub issue. You should see the following things occur: | ||
| - A comment is made on the issue saying `Task created: https://<your-coder-url>/tasks/username/task-id` | ||
| - A Coder Task will spin up, and you'll receive a Tasks notification to that effect | ||
| - You can click the link to follow the Task's progress in creating a plan to solve your bug | ||
| Depending on the complexity of the task and the size of your repository, the Coder Task may take minutes or hours to complete. Our recommendation is to rely on Task Notifications to know when the Task completes, and further action is required. | ||
| And that’s it! You may now enjoy all the hours you have saved because of this easy integration. | ||
| ### Step 4: Adapt this Workflow to your Processes | ||
| Following the above steps sets up a GitHub Workflow that will | ||
| 1. Allow you to label bugs with `coder` | ||
| 1. A coding agent will determine a plan to address the bug | ||
| 1. You'll receive a notification to review the plan and prompt the agent to proceed, or change course | ||
| We recommend that you further adapt this workflow to better match your process. For example, you could: | ||
| - Modify the prompt to implement the plan it came up with, and then create a PR once it has a solution | ||
| - Update your GitHub issue template to automatically apply the `coder` label to attempt to solve bugs that have been logged | ||
| - Modify the underlying use case to handle updating documentation, implementing a small feature, reviewing bug reports for completeness, or even writing unit tests | ||
| - Modify the workflow trigger for other scenarios such as: | ||
| ```yml | ||
| # Comment-based trigger slash commands | ||
| on: | ||
| issue_comment: | ||
| types: [created] | ||
| jobs: | ||
| trigger-on-comment: | ||
| runs-on: ubuntu-latest | ||
| if: startsWith(github.event.comment.body, '/coder') | ||
| # On Pull Request Creation | ||
| jobs: | ||
| on-pr-opened: | ||
| runs-on: ubuntu-latest | ||
| # No if needed - just runs on PR open | ||
| # On changes to a specific directory | ||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| - 'src/api/**' | ||
| - '*.md' | ||
| jobs: | ||
| on-docs-changed: | ||
| runs-on: ubuntu-latest | ||
| # Runs automatically when files in these paths change | ||
| ``` | ||
| ## Summary | ||
| This guide shows you how to automatically delegate routine engineering work to AI coding agents by connecting GitHub issues to Coder Tasks. When you label an issue (like a bug report or documentation update), a coding agent spins up in a secure Coder workspace, reads the issue context, and works on solving it while you focus on higher-priority tasks. The agent reports back with a proposed solution for you to review and approve, turning hours of repetitive work into minutes of oversight. This same pattern can be adapted to handle documentation updates, test writing, code reviews, and other automatable workflows across your development process. | ||
| ## Troubleshooting | ||
| ### "No Coder user found with GitHub user ID X" | ||
| **Cause:** The user who triggered the workflow hasn't linked their GitHub account to Coder. | ||
| **Solution:** | ||
| 1. Ensure GitHub OAuth is configured in your Coder deployment (see [External Authentication docs](https://coder.com/docs/admin/external-auth#configure-a-github-oauth-app)) | ||
| 1. Have the user visit `https://<your-coder-url>/settings/external-auth` and link their GitHub account | ||
| 1. Retry the workflow by re-applying the `coder` label or however else the workflow is triggered | ||
| ### "Failed to create task: 403 Forbidden" | ||
| **Cause:** The `coder-token` doesn't have the required permissions. | ||
| **Solution:** The token must have: | ||
| - Read users in organization | ||
| - Create tasks for any user | ||
| Generate a new token with these permissions at `https://<your-coder-url>/deployment/general`. See the [Coder Create Task GHA requirements](https://github.com/coder/create-task-action?tab=readme-ov-file#requirements) for more specific information. | ||
| ### "Template 'my-template' not found" | ||
| **Cause:** The `coder-template-name` is incorrect or the template doesn't exist in the specified organization. | ||
| **Solution:** | ||
| 1. Verify the template name using: `coder templates list --org your-org-name` | ||
| 1. Update the `coder-template-name` input in your workflow file to match exactly, or input secret or variable saved in GitHub | ||
| 1. Ensure the template exists in the organization specified by `coder-organization` | ||
| ### Task fails with "authentication failed" or "Bad credentials" after running for hours | ||
| **Symptoms:** | ||
| - Task starts successfully and works initially | ||
| - After some time passes, `gh` CLI commands fail with: | ||
| - `authentication failed` | ||
| - `Bad credentials` | ||
| - `HTTP 401 Unauthorized` | ||
| - `error getting credentials` from git operations | ||
| **Cause:** The GitHub token expired during task execution. Tokens passed as environment variables are captured at task creation time and expire after 8 hours (for GitHub Apps with expiration enabled). These tokens are not automatically refreshed during task execution. | ||
| **Diagnosis:** | ||
| From within the running task workspace, check if the token is still valid: | ||
| ```bash | ||
| # Check if the token still works | ||
| curl -H "Authorization: token ${GITHUB_TOKEN}" \ | ||
| https://api.github.com/user | ||
| ``` | ||
| If this returns 401 Unauthorized or Bad credentials, the token has expired. | ||
| **Solution:** | ||
| 1. Have the user re-authenticate at https://<your-coder-url>/settings/external-auth | ||
| 1. Verify the GitHub provider shows "Authenticated" with a green checkmark | ||
| 1. Re-trigger the workflow to create a new task with a fresh token |
6 changes: 6 additions & 0 deletionsdocs/manifest.json
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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.