Skip to content

Commit fcb302c

Browse files
davanstriendavanstrien
committed
Add guide for automating code review with OpenCode and IP
1 parent 94c679e commit fcb302c

File tree

1 file changed

+194
-0
lines changed

1 file changed

+194
-0
lines changed

‎docs/inference-providers/guides/github-actions-code-review.md‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
# Automating Code Review with GitHub Actions
2+
3+
[OpenCode](https://opencode.ai) is an AI coding agent that runs in your terminal and can work with open models via Hugging Face Inference Providers.
4+
5+
You can also install OpenCode as a GitHub App to help automate GitHub workflows!
6+
7+
In less than 5 minutes, you can set it up to respond to issues and pull requests using powerful open source language models.
8+
9+
This guide shows you how to use Hugging Face Inference Providers with OpenCode to power GitHub automation. You'll be able to triage issues, implement features, and review code using models like DeepSeek, GLM-4.5, and Kimi K2.
10+
11+
> [!TIP]
12+
> This guide assumes you have a Hugging Face account and a GitHub repository. You can create a free Hugging Face account at [huggingface.co](https://huggingface.co).
13+
14+
## What the OpenCode GitHub App Does
15+
16+
Once set up, OpenCode will respond to `/oc` or `/opencode` commands in GitHub issues and pull requests:
17+
18+
- **Triage and explain issues** - Ask OpenCode to analyze an issue and explain it
19+
- **Implement features** - Request a fix or feature, and OpenCode creates a PR with the changes
20+
- **Review and modify PRs** - Request changes on pull requests and OpenCode commits them
21+
22+
The entire workflow runs securely in your GitHub Actions runners, and you maintain full control over which repositories you install the OpenCode GitHub app on.
23+
24+
## Step 1: Install OpenCode
25+
26+
First, install OpenCode on your local machine see the [installation instructions](https://opencode.ai/docs/#install).
27+
28+
## Step 2: Configure OpenCode for GitHub
29+
30+
Navigate to your local clone of your GitHub repository and run the setup command:
31+
32+
```bash
33+
cd your-repository
34+
opencode github install
35+
```
36+
37+
This interactive setup will guide you through:
38+
39+
1. **Installing the GitHub app** - Your browser opens to authorize OpenCode for your repositories. You can choose specific repositories or all repositories.
40+
2. **Selecting a provider** - Choose **Hugging Face** from the list
41+
3. **Choosing a model** - Select a model like **GLM-4.5-Air** or **Kimi-K2-Instruct**
42+
4. **Creating the workflow** - Generates `.github/workflows/opencode.yml` automatically
43+
44+
Once the `.github/workflows/opencode.yml` file is created, you'll need to commit and push it to your repository:
45+
46+
```bash
47+
git add .github/workflows/opencode.yml
48+
git commit -m "Add OpenCode workflow"
49+
git push
50+
```
51+
52+
After the setup completes, you'll need to add your Hugging Face token as a repository secret:
53+
54+
1. Get a token from your [Hugging Face settings](https://huggingface.co/settings/tokens/new?ownUserPermissions=inference.serverless.write&tokenType=fineGrained). The token needs permissions to `Make calls to Inference Providers`.
55+
2. In your GitHub repository, go to **Settings → Secrets and variables → Actions**
56+
3. Click **New repository secret**
57+
4. Name it `HF_TOKEN` and paste your token
58+
59+
> [!TIP]
60+
> Make sure your Hugging Face token has Inference Providers permissions enabled. We recommend creating a separate token specifically for OpenCode usage.
61+
62+
## Step 3: Try It Out
63+
64+
Once your workflow is set up and your token is configured, test it by commenting on any issue:
65+
66+
```
67+
68+
/oc summarize
69+
70+
```
71+
72+
OpenCode will analyze the issue and provide a summary. Here are other commands you can try:
73+
74+
**Explain an issue:**
75+
76+
```
77+
78+
/opencode explain this issue
79+
80+
```
81+
82+
**Implement a fix:**
83+
84+
```
85+
86+
/oc fix this
87+
88+
```
89+
90+
OpenCode creates a new branch, implements the changes, and opens a pull request.
91+
92+
**Request changes on a PR:**
93+
94+
```
95+
96+
/oc please add error handling
97+
98+
```
99+
100+
> [!TIP]
101+
> Use `/oc` (short) or `/opencode` (long) to trigger commands. OpenCode understands natural language, so feel free to be specific about what you need.
102+
103+
## Security Considerations
104+
105+
> [!WARNING]
106+
> On public repositories, anyone can trigger the bot by commenting `/oc` or `/opencode`. This could lead to unexpected inference costs or unwanted PRs. Consider:
107+
>
108+
> - **Using a separate Hugging Face token** specifically for OpenCode (not your main token), so you can revoke it if needed without affecting other services
109+
> - Monitoring your Hugging Face usage to track costs
110+
> - Adding workflow conditions to restrict who can trigger the bot (e.g., only repository collaborators)
111+
> - Starting with a private repository or test repo to control access
112+
113+
## Example Workflow in Action
114+
115+
Here's a real example from a [fork of the Hugging Face datasets repository](https://github.com/davanstrien/datasets). The issue requests adding `uv` installation support:
116+
117+
![Example Issue](./images/opencode-example-issue.png)
118+
119+
When someone comments `/oc fix this`, OpenCode analyzes the issue, creates a new branch, implements the changes, and opens a pull request:
120+
121+
![Bot Created PR](./images/opencode-bot-created-pr.png)
122+
123+
The PR includes all the necessary changes:
124+
125+
![PR Changes](./images/opencode-pr-diff.png)
126+
127+
## Switching Models
128+
129+
Different models offer different trade-offs between speed, cost, and capability. You can experiment with various models by editing the workflow file.
130+
131+
Edit `.github/workflows/opencode.yml` and update the `model` parameter:
132+
133+
```yaml
134+
with:
135+
model: huggingface/deepseek-ai/DeepSeek-V3 # Powerful reasoning
136+
# or
137+
model: huggingface/zai-org/GLM-4.5-Air # Balanced performance
138+
```
139+
140+
Commit and push the changes:
141+
142+
```bash
143+
git add .github/workflows/opencode.yml
144+
git commit -m "Switch to the DeepSeek model"
145+
git push
146+
```
147+
148+
## Understanding the Workflow
149+
150+
The setup wizard generates `.github/workflows/opencode.yml`, which defines when and how OpenCode runs:
151+
152+
```yaml
153+
name: opencode
154+
155+
on:
156+
issue_comment:
157+
types: [created] # Trigger on new comments
158+
159+
jobs:
160+
opencode:
161+
# Only run if comment contains /oc or /opencode
162+
if: |
163+
contains(github.event.comment.body, ' /oc') ||
164+
startsWith(github.event.comment.body, '/oc') ||
165+
contains(github.event.comment.body, ' /opencode') ||
166+
startsWith(github.event.comment.body, '/opencode')
167+
168+
runs-on: ubuntu-latest
169+
170+
permissions:
171+
id-token: write # Required for OpenCode authentication
172+
contents: read # Read repository contents
173+
pull-requests: read # Access PR information
174+
issues: read # Access issue information
175+
176+
steps:
177+
- name: Checkout repository
178+
uses: actions/checkout@v4
179+
180+
- name: Run opencode
181+
uses: sst/opencode/github@latest
182+
env:
183+
HF_TOKEN: ${{ secrets.HF_TOKEN }} # Your Hugging Face token
184+
with:
185+
model: huggingface/zai-org/GLM-4.5-Air # The model to use
186+
```
187+
188+
The workflow triggers whenever someone comments on an issue or PR with `/oc` or `/opencode`, checks out your repository code, and runs OpenCode with your chosen model from Hugging Face Inference Providers.
189+
190+
## Next Steps
191+
192+
- Explore the [OpenCode GitHub documentation](https://opencode.ai/docs/github/) for advanced configuration
193+
- Browse [models available through Inference Providers](https://huggingface.co/models?pipeline_tag=text-generation&inference_provider=cerebras,together,fireworks-ai,nebius,novita,sambanova,groq,hyperbolic,nscale,fal-ai,cohere,replicate,scaleway&sort=trending) to find the best model for your needs
194+
- Try OpenCode in a private repository first to test with controlled access

0 commit comments

Comments
 (0)