GitHub action to run AI commands as part of pipelines. Review code, comment on pull requests, open pull requests to add tests and more.
Caution: be mindful of costs given how many calls to APIs automated reviews can make, as well as how many tokens may be needed.
To use the terminal-ai-action:
- Create a workflow, e.g.
.github/workflows/review.yaml - Set an
openAiApiKey, which will let you call theaiCLI - Pass your prompts to
ai, use optional Helper Functions likeai_pr_diffto easily get diffs / logs / etc - Put results into comments, open pull requests and so on
name: Review PR
on:
pull_request:
jobs:
review:
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # get the full history.
# Review the code. Examples in this repo show how to comment etc.
- uses: dwmkerr/terminal-ai-action@latest
with:
openAiApiKey: ${{ secrets.OPENAI_API_KEY }}
command: ai "review this PR" < ai_pr_diffReview the changes in a pull request, suggest improvements, suggest a title and description
The following configuration is supported:
| Configuration | Description |
|---|---|
openAiApiKey |
Required. OpenAI API Key. |
command |
Required. The command to run. See Examples |
Terminal AI requires that an OpenAI API Key is set. You can create a key by following the guide at OpenAI Platform - API Keys. Once you have a key it is recommended to store it in an Action Secret:
Once you have created the secret you can pass it to the terminal-ai-action like so:
jobs:
review:
steps:
- name: Review with Terminal AI
uses: dwmkerr/terminal-ai-action@latest
with:
openAiApiKey: ${{ secrets.OPENAI_API_KEY }}
command: ai "review this PR"Some scripts are available to run as part of the command to conveniently work with the code. They are linked into the bin folder so can be called directly, e.g:
# Get the diff of the PR to its base:
ai-pr-diff > ai "summarise this PR"Available helpers:
| Script | Description |
|---|---|
ai-pr-diff |
The result of git diff from a pull request to its target branch. |
Quick and dirty task list:
- docs: nice example of great README page
- docs: show examples of how to comment etc