aljaz/opencode
1
0
Fork 0
mirror of https://github.com/aljazceru/opencode.git synced 2025-12-21 09:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: gitlab

Browse Source
This commit is contained in:
Jay V
2025-08-20 17:51:16 -04:00
parent 8b01676ec0
commit 256d074411
2 changed files with 96 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/web/astro.config.mjs
View File

@@ -67,7 +67,14 @@ export default defineConfig({
{ {
label: "Usage", label: "Usage",
items: ["docs/tui", "docs/cli", "docs/ide", "docs/share", "docs/github"], items: [
"docs/tui",
"docs/cli",
"docs/ide",
"docs/share",
"docs/github",
"docs/gitlab"
],
}, },
{ {

157
packages/web/src/content/docs/docs/gitlab.mdx
View File

@@ -19,81 +19,96 @@ Mention `@opencode` in a comment, and opencode will execute tasks within your Gi
## Setup ## Setup
Refer to the [GitLab CLI agents docs](https://docs.gitlab.com/user/duo_agent_platform/agent_assistant/) opencode runs in your GitLab CI/CD pipeline, here's what you'll need to set it up:
for detailed setup instructions.
Here is an example of the agent configuration: :::tip
Check out the [**GitLab docs**](https://docs.gitlab.com/user/duo_agent_platform/agent_assistant/) for up to date instructions.
:::
```yaml 1. Configure your GitLab environment
image: node:22-slim 2. Set up CI/CD
commands: 3. Get an AI model provider API key
- echo "Installing opencode" 4. Create a service account
- npm install --global opencode-ai 5. Configure CI/CD variables
- echo "Installing glab" 6. Create a flow config file, here's an example:
- export GITLAB_TOKEN=$GITLAB_TOKEN_OPENCODE
- apt-get update --quiet && apt-get install --yes curl wget gpg git && rm --recursive --force /var/lib/apt/lists/*
- curl --silent --show-error --location "https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository" | bash
- apt-get install --yes glab
- echo "Configuring glab"
- echo $GITLAB_HOST
- echo "Creating opencode auth configuration"
- mkdir --parents ~/.local/share/opencode
- |
cat > ~/.local/share/opencode/auth.json << EOF
{
"anthropic": {
"type": "api",
"key": "$ANTHROPIC_API_KEY"
}
}
EOF
- echo "Configuring git"
- git config --global user.email "opencode@gitlab.com"
- git config --global user.name "Opencode"
- echo "Testing glab"
- glab issue list
- echo "Running Opencode"
- |
opencode run "
You are an AI assistant helping with GitLab operations.
Context: $AI_FLOW_CONTEXT <details>
Task: $AI_FLOW_INPUT <summary>Flow configuration</summary>
Event: $AI_FLOW_EVENT
Please execute the requested task using the available GitLab tools. ```yaml
Be thorough in your analysis and provide clear explanations. image: node:22-slim
commands:
- echo "Installing opencode"
- npm install --global opencode-ai
- echo "Installing glab"
- export GITLAB_TOKEN=$GITLAB_TOKEN_OPENCODE
- apt-get update --quiet && apt-get install --yes curl wget gpg git && rm --recursive --force /var/lib/apt/lists/*
- curl --silent --show-error --location "https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository" | bash
- apt-get install --yes glab
- echo "Configuring glab"
- echo $GITLAB_HOST
- echo "Creating opencode auth configuration"
- mkdir --parents ~/.local/share/opencode
- |
cat > ~/.local/share/opencode/auth.json << EOF
{
"anthropic": {
"type": "api",
"key": "$ANTHROPIC_API_KEY"
}
}
EOF
- echo "Configuring git"
- git config --global user.email "opencode@gitlab.com"
- git config --global user.name "Opencode"
- echo "Testing glab"
- glab issue list
- echo "Running Opencode"
- |
opencode run "
You are an AI assistant helping with GitLab operations.
<important> Context: $AI_FLOW_CONTEXT
Please use the glab CLI to access data from GitLab. The glab CLI has already been authenticated. You can run the corresponding commands. Task: $AI_FLOW_INPUT
Event: $AI_FLOW_EVENT
If you are asked to summarise an MR or issue or asked to provide more information then please post back a note to the MR/Issue so that the user can see it. Please execute the requested task using the available GitLab tools.
You don't need to commit or push up changes, those will be done automatically based on the file changes you make. Be thorough in your analysis and provide clear explanations.
</important>
" <important>
- git checkout --branch $CI_WORKLOAD_REF origin/$CI_WORKLOAD_REF Please use the glab CLI to access data from GitLab. The glab CLI has already been authenticated. You can run the corresponding commands.
- echo "Checking for git changes and pushing if any exist"
- | If you are asked to summarise an MR or issue or asked to provide more information then please post back a note to the MR/Issue so that the user can see it.
if ! git diff --quiet || ! git diff --cached --quiet || [ --not --zero "$(git ls-files --others --exclude-standard)" ]; then You don't need to commit or push up changes, those will be done automatically based on the file changes you make.
echo "Git changes detected, adding and pushing..." </important>
git add . "
if git diff --cached --quiet; then - git checkout --branch $CI_WORKLOAD_REF origin/$CI_WORKLOAD_REF
echo "No staged changes to commit" - echo "Checking for git changes and pushing if any exist"
else - |
echo "Committing changes to branch: $CI_WORKLOAD_REF" if ! git diff --quiet || ! git diff --cached --quiet || [ --not --zero "$(git ls-files --others --exclude-standard)" ]; then
git commit --message "Codex changes" echo "Git changes detected, adding and pushing..."
echo "Pushing changes up to $CI_WORKLOAD_REF" git add .
git push https://gitlab-ci-token:$GITLAB_TOKEN@$GITLAB_HOST/gl-demo-ultimate-dev-ai-epic-17570/test-java-project.git $CI_WORKLOAD_REF if git diff --cached --quiet; then
echo "Changes successfully pushed" echo "No staged changes to commit"
fi else
else echo "Committing changes to branch: $CI_WORKLOAD_REF"
echo "No git changes detected, skipping push" git commit --message "Codex changes"
fi echo "Pushing changes up to $CI_WORKLOAD_REF"
variables: git push https://gitlab-ci-token:$GITLAB_TOKEN@$GITLAB_HOST/gl-demo-ultimate-dev-ai-epic-17570/test-java-project.git $CI_WORKLOAD_REF
- ANTHROPIC_API_KEY echo "Changes successfully pushed"
- GITLAB_TOKEN_OPENCODE fi
- GITLAB_HOST else
``` echo "No git changes detected, skipping push"
fi
variables:
- ANTHROPIC_API_KEY
- GITLAB_TOKEN_OPENCODE
- GITLAB_HOST
```
</details>
You can refer to the [GitLab CLI agents docs](https://docs.gitlab.com/user/duo_agent_platform/agent_assistant/) for detailed instructions.
--- ---
@@ -101,6 +116,10 @@ variables:
Here are some examples of how you can use opencode in GitLab. Here are some examples of how you can use opencode in GitLab.
:::tip
You can configure to use a different trigger phrase than `@opencode`.
:::
- **Explain an issue** - **Explain an issue**
Add this comment in a GitLab issue. Add this comment in a GitLab issue.