├── .gitignore ├── README.md ├── docs └── issue-to-pr.md ├── .github └── workflows │ └── aider-issue-to-pr.yml └── LICENCE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Aider GitHub Workflows 2 | 3 | Workflows in this repo use [aider-github-action](https://github.com/mirrajabi/aider-github-action) to automate your daily GitHub tasks! 4 | 5 | ## Workflows 6 | 7 | Here are the workflows that are currently available: 8 | 9 | - :zap: [Issue to PR](#issue-to-pr-workflow) [[docs](./docs/issue-to-pr.md)] 10 | 11 | ### [Issue to PR Workflow](./docs/issue-to-pr.md) 12 | 13 | Tag your issues with "aider" and let AI Automatically generate a PR for you! A minute later you can review the code! 14 | -------------------------------------------------------------------------------- /docs/issue-to-pr.md: -------------------------------------------------------------------------------- 1 | # Aider Issue to PR Workflow 2 | 3 | Don't waste time writing code for simple features anymore! Just tag your issues and let AI Automatically generate a PR for you! 4 | 5 | See [a demo](#example) of how it works. 6 | 7 | ## Usage 8 | 9 | The recommended way to use this workflow is to call it when an issue is labeled. 10 | 11 | 1. Set `OPENAI_API_KEY` secret in your repository settings. You can get your API key from [OpenAI](https://platform.openai.com/api-keys). 12 | 1. Create file `.github/workflows/aider-on-issue-labeled.yml` in your project with the following contents: 13 | 14 | ```yaml 15 | name: Auto-generate PR using Aider 16 | on: 17 | issues: 18 | types: [labeled] 19 | 20 | jobs: 21 | generate: 22 | uses: mirrajabi/aider-github-workflows/.github/workflows/aider-issue-to-pr.yml@v1.0.0 23 | # Check if the label is 'aider' 24 | if: github.event.label.name == 'aider' 25 | with: 26 | issue-number: ${{ github.event.issue.number }} 27 | base-branch: ${{ github.event.repository.default_branch }} 28 | # Exit if the action is taking longer than 10 minutes 29 | chat-timeout: 10 30 | api_key_env_name: OPENAI_API_KEY 31 | model: o3-mini-2025-01-31 32 | secrets: 33 | api_key_env_value: ${{ secrets.OPENAI_API_KEY }} 34 | 35 | ``` 36 | 37 | ## Inputs 38 | 39 | You can pass the following arguments to the workflow: 40 | 41 | | Field Name | Description | Required | Type | Default | 42 | |-----------------|---------------------------------------------------------------|----------|---------|--------------------------| 43 | | `base-branch` | Base branch to create PR against | **true** | string | - | 44 | | `chat-timeout` | Timeout for chat in *minutes* to prevent burning your credits | false | number | `10` | 45 | | `issue-number` | Issue number | **true** | number | - | 46 | | `api_key_env_name` | "The name of the environment variable. For example, OPENAI_API_KEY, ANTHROPIC_API_KEY, etc. See more info [here](https://aider.chat/docs/llms.html) | **false** | string | - | 47 | | `model` | Model to use | true | string | - | 48 | 49 | ### Secrets 50 | 51 | | Field Name | Description | Required | Type | Default | 52 | |-----------------|---------------------------------------------------------------|----------|---------|--------------------------| 53 | | `api_key_env_value` | The API Key to use as the value of the `api_key_env_name` | **false** | string | - | 54 | 55 | ## Example 56 | 57 | In [aider-github-workflows-test](https://github.com/mirrajabi/aider-github-workflows-test/issues) project you can find the following which demonstrate the full flow from Issue to generated PR. 58 | 59 | 1. [An issue](https://github.com/mirrajabi/aider-github-workflows-test/issues/1) that triggers the workflow. 60 | 1. [The workflow run](https://github.com/mirrajabi/aider-github-workflows-test/actions/runs/7365235652) 61 | 1. [A Pull request](https://github.com/mirrajabi/aider-github-workflows-test/pull/2) that was created 62 | 63 | ## Roadmap 64 | 65 | - [ ] Add support for in PR chat and revisions 66 | 67 | ## Disclaimer 68 | 69 | You are responsible for the AI credit that is spent. All contributors in a GitHub project will be able to label issues which will trigger the workflow. Non-contributors are not be able to tag issues which helps greatly in preventing abuse. 70 | -------------------------------------------------------------------------------- /.github/workflows/aider-issue-to-pr.yml: -------------------------------------------------------------------------------- 1 | name: Aider Issue to PR workflow 2 | on: 3 | workflow_call: 4 | inputs: 5 | base-branch: 6 | description: "Base branch to create PR against" 7 | required: true 8 | type: string 9 | chat-timeout: 10 | description: "Timeout for chat in minutes to prevent burning your credits" 11 | required: false 12 | type: number 13 | default: 10 14 | issue-number: 15 | description: "Issue number" 16 | required: true 17 | type: number 18 | api_key_env_name: 19 | description: "The name of the environment variable. For example, OPENAI_API_KEY, ANTHROPIC_API_KEY, etc. See more info: https://aider.chat/docs/llms.html" 20 | # Will be required when the old way of passing API keys is removed. 21 | required: false 22 | type: string 23 | default: "" 24 | model: 25 | description: "Model to use" 26 | required: true 27 | type: string 28 | secrets: 29 | api_key_env_value: 30 | description: "API key value" 31 | # Will be required when the old way of passing API keys is removed. 32 | required: false 33 | # Deprecated and will be removed in future versions. 34 | openai_api_key: 35 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] OpenAI API key" 36 | required: false 37 | anthropic_api_key: 38 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] Anthropic API Key" 39 | required: false 40 | gemini_api_key: 41 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] Gemini API Key" 42 | required: false 43 | groq_api_key: 44 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] Groq API Key" 45 | required: false 46 | cohere_api_key: 47 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] Cohere API Key" 48 | required: false 49 | deepseek_api_key: 50 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] Deepseek API Key" 51 | required: false 52 | openrouter_api_key: 53 | description: "[Deprecated - use api_key_env_name and api_key_env_value instead] OpenRouter API Key" 54 | required: false 55 | 56 | jobs: 57 | create-pull-request: 58 | permissions: 59 | issues: read 60 | pull-requests: write 61 | contents: write 62 | runs-on: ubuntu-latest 63 | steps: 64 | - name: Checkout 65 | uses: actions/checkout@v4 66 | with: 67 | ref: ${{ github.ref }} 68 | 69 | - name: Create a new branch 70 | uses: actions/github-script@v7 71 | id: create_branch 72 | with: 73 | script: | 74 | const kebabCase = (str) => { 75 | return str 76 | .toLowerCase() 77 | .trim() 78 | .replace(/[^\w\s-]/g, '') // Remove invalid characters 79 | .replace(/\s+/g, '-') // Replace spaces with dashes 80 | .replace(/^-+|-+$/g, ''); // Remove leading/trailing dashes 81 | }; 82 | 83 | const fixBranchUrl = (url) => url 84 | .replace(/\/git\/commits/, '/commit') 85 | .replace(/api.github.com\/repos/, 'github.com'); 86 | 87 | // New branch should be based on the base-branch, so we need to get its SHA 88 | const baseBranch = await github.rest.repos.getBranch({ 89 | owner: context.repo.owner, 90 | repo: context.repo.repo, 91 | branch: '${{ inputs.base-branch }}' 92 | }); 93 | 94 | const { repo, owner } = context.repo; 95 | const branchName = 'feature/aider-' + kebabCase(context.payload.issue.title); 96 | const refName = `refs/heads/${branchName}` 97 | const refShortName = `heads/${branchName}` 98 | 99 | // Get existing ref if exists 100 | const existingRef = await github.rest.git.getRef({ 101 | owner, 102 | repo, 103 | ref: refShortName 104 | }).catch(() => null); 105 | 106 | if (existingRef) { 107 | try { 108 | // If there's a branch for this ref, return the ref 109 | await github.rest.repos.getBranch({ 110 | owner, 111 | repo, 112 | branch: branchName 113 | }); 114 | 115 | console.log(`Branch ${branchName} already exists with SHA ${existingRef.data.object.sha}`); 116 | console.log(`Branch URL: ${fixBranchUrl(existingRef.data.object.url)}`); 117 | 118 | return { ref: existingRef.data.ref } 119 | } catch (e) { 120 | console.error(e); 121 | // State recovery: If there's a ref but no branch, delete the ref and create a new branch 122 | // This can happen if the branch was deleted manually. The ref will still exist. 123 | console.log(`Branch ${branchName} doesn't exist, deleting ref ${refShortName}`); 124 | await github.rest.git.deleteRef({ 125 | owner, 126 | repo, 127 | ref: refShortName 128 | }); 129 | } 130 | } 131 | 132 | // Create branch 133 | const result = await github.rest.git.createRef({ 134 | owner, 135 | repo, 136 | ref: refName, 137 | sha: baseBranch.data.commit.sha 138 | }); 139 | 140 | console.log(`Created branch ${branchName} with SHA ${result.data.object.sha}`); 141 | console.log(`Branch URL: ${fixBranchUrl(result.data.object.url)}`); 142 | 143 | return { ref: result.data.ref } 144 | 145 | - name: Get issue 146 | uses: actions/github-script@v7 147 | id: get_issue 148 | with: 149 | script: | 150 | console.log('Fetching issue #${{ inputs.issue-number }}') 151 | const { repo, owner } = context.repo; 152 | const result = await github.rest.issues.get({ 153 | owner, 154 | repo, 155 | issue_number: ${{ inputs.issue-number }} 156 | }); 157 | console.log(`Fetched issue #${result.data.number}: ${result.data.title}`) 158 | 159 | return { 160 | title: result.data.title.replace(/"/g, "'").replace(/`/g, '\\`'), 161 | body: result.data.body.replace(/"/g, "'").replace(/`/g, '\\`'), 162 | }; 163 | - name: Create prompt 164 | uses: actions/github-script@v7 165 | id: create_prompt 166 | with: 167 | result-encoding: string 168 | script: | 169 | const title = `${{ fromJson(steps.get_issue.outputs.result).title }}`; 170 | const body = `${{ fromJson(steps.get_issue.outputs.result).body }}`; 171 | 172 | return `Apply all necessary changes based on below issue description. \nIssue title: ${title}\nIssue description:\n${body}`; 173 | - name: Apply changes with Aider 174 | uses: mirrajabi/aider-github-action@v1.1.0 175 | timeout-minutes: ${{ inputs.chat-timeout }} 176 | with: 177 | branch: ${{ fromJson(steps.create_branch.outputs.result).ref }} 178 | model: ${{ inputs.model }} 179 | aider_args: '--yes --message "${{ steps.create_prompt.outputs.result }}"' 180 | api_key_env_name: ${{ inputs.api_key_env_name }} 181 | api_key_env_value: ${{ secrets.api_key_env_value }} 182 | # Deprecated way of passing API keys. Will be removed in future versions. 183 | openai_api_key: ${{ secrets.openai_api_key }} 184 | anthropic_api_key: ${{ secrets.anthropic_api_key }} 185 | cohere_api_key: ${{ secrets.cohere_api_key }} 186 | deepseek_api_key: ${{ secrets.deepseek_api_key }} 187 | gemini_api_key: ${{ secrets.gemini_api_key }} 188 | groq_api_key: ${{ secrets.groq_api_key }} 189 | openrouter_api_key: ${{ secrets.openrouter_api_key }} 190 | 191 | - name: Create Pull Request 192 | uses: actions/github-script@v7 193 | with: 194 | script: | 195 | const { repo, owner } = context.repo; 196 | const branchRef = '${{ fromJson(steps.create_branch.outputs.result).ref }}' 197 | 198 | // If PR already exists, return it 199 | const pulls = await github.rest.pulls.list({ 200 | owner, 201 | repo, 202 | state: 'open', 203 | per_page: 100 204 | }); 205 | 206 | const existingPR = pulls.data.find((pr) => pr.head.ref === branchRef); 207 | if (existingPR) { 208 | console.log(`PR #${existingPR.number} already exists: ${existingPR.html_url}`); 209 | return existingPR; 210 | } 211 | 212 | const newPR = await github.rest.pulls.create({ 213 | title: '[Aider] ' + '${{ fromJson(steps.get_issue.outputs.result).title }}', 214 | owner, 215 | repo, 216 | head: branchRef, 217 | base: 'refs/heads/${{ inputs.base-branch }}', 218 | body: [ 219 | 'This PR is auto-generated by Aider Workflow.', 220 | '[mirrajabi/aider-github-action](https://github.com/mirrajabi/aider-github-action).', 221 | '', 222 | `Fixes #${{ inputs.issue-number }}`, 223 | ].join('\n') 224 | }); 225 | github.rest.issues.addLabels({ 226 | owner, 227 | repo, 228 | issue_number: newPR.data.number, 229 | labels: ['automated-pr'] 230 | }); 231 | 232 | console.log(`Created PR #${newPR.data.number}: ${newPR.data.html_url}`); 233 | - name: Upload aider chat history 234 | uses: actions/upload-artifact@v4 235 | with: 236 | name: aider-chat-output 237 | path: ".aider.chat.history.md" 238 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. --------------------------------------------------------------------------------