# CI/CD Environments > Set up goose in your CI/CD pipeline to automate tasks - 网址：https://funcoding.ai/agents/goose/tutorials/cicd/ - 来源：goose 官方文档原文（英文），Apache-2.0 许可，同步于 2026-10-11 - 官方原文：https://goose-docs.ai/docs/tutorials/cicd --- goose isn’t just useful on your local machine, it can also streamline tasks in CI/CD environments. By integrating goose into your pipeline, you can automate tasks such as: - Code reviews - Documentation checks - Build and deployment workflows - Infrastructure and environment management - Rollbacks and recovery processes - Intelligent test execution This guide walks you through setting up goose in your CI/CD pipeline, with a focus on using GitHub Actions for code reviews. ## Using goose with GitHub Actions You can run goose directly within GitHub Actions. Follow these steps to set up your workflow.
**TLDR**
Copy the GitHub Workflow ```yaml title="goose.yml" name: goose on: pull_request: types: [opened, synchronize, reopened, labeled] permissions: contents: write pull-requests: write issues: write env: PROVIDER_API_KEY: ${{ secrets.REPLACE_WITH_PROVIDER_API_KEY }} PR_NUMBER: ${{ github.event.pull_request.number }} GH_TOKEN: ${{ github.token }} jobs: goose-comment: name: goose Comment runs-on: ubuntu-latest steps: - name: Check out repository uses: actions/checkout@v4 with: fetch-depth: 0 - name: Gather PR information run: | { echo "# Files Changed" gh pr view $PR_NUMBER --json files \ -q '.files[] | "* " + .path + " (" + (.additions|tostring) + " additions, " + (.deletions|tostring) + " deletions)"' echo "" echo "# Changes Summary" gh pr diff $PR_NUMBER } > changes.txt - name: Install goose CLI run: | mkdir -p /home/runner/.local/bin curl -fsSL https://github.com/aaif-goose/goose/releases/download/stable/download_cli.sh \ | GOOSE_VERSION=REPLACE_WITH_VERSION CONFIGURE=false GOOSE_BIN_DIR=/home/runner/.local/bin bash echo "/home/runner/.local/bin" >> $GITHUB_PATH - name: Configure goose run: | mkdir -p ~/.config/goose cat < ~/.config/goose/config.yaml GOOSE_PROVIDER: REPLACE_WITH_PROVIDER GOOSE_MODEL: REPLACE_WITH_MODEL keyring: false EOF - name: Create instructions for goose run: | cat < instructions.txt Create a summary of the changes provided. Don't provide any session or logging details. The summary for each file should be brief and structured as: - dot points of changes You don't need any extensions, don't mention extensions at all. The changes to summarise are: $(cat changes.txt) EOF - name: Test run: cat instructions.txt - name: Run goose and filter output run: | goose run --instructions instructions.txt | \ # Remove ANSI color codes sed -E 's/\x1B\[[0-9;]*[mK]//g' | \ # Remove session/logging lines grep -v "logging to /home/runner/.config/goose/sessions/" | \ grep -v "^starting session" | \ grep -v "^Closing session" | \ # Trim trailing whitespace sed 's/[[:space:]]*$//' \ > pr_comment.txt - name: Post comment to PR run: | cat -A pr_comment.txt gh pr comment $PR_NUMBER --body-file pr_comment.txt ```
### 1. Create the Workflow File Create a new file in your repository at `.github/workflows/goose.yml`. This will contain your GitHub Actions workflow. ### 2. Define the Workflow Triggers and Permissions Configure the action such that it: - Triggers the workflow when a pull request is opened, updated, reopened, or labeled - Grants the necessary permissions for goose to interact with the repository - Configures environment variables for your chosen LLM provider ```yaml name: goose on: pull_request: types: [opened, synchronize, reopened, labeled] permissions: contents: write pull-requests: write issues: write env: PROVIDER_API_KEY: ${{ secrets.REPLACE_WITH_PROVIDER_API_KEY }} PR_NUMBER: ${{ github.event.pull_request.number }} ``` ### 3. Install and Configure goose To install and set up goose in your workflow, add the following steps: ```yaml steps: - name: Install goose CLI run: | mkdir -p /home/runner/.local/bin curl -fsSL https://github.com/aaif-goose/goose/releases/download/stable/download_cli.sh \ | GOOSE_VERSION=REPLACE_WITH_VERSION CONFIGURE=false GOOSE_BIN_DIR=/home/runner/.local/bin bash echo "/home/runner/.local/bin" >> $GITHUB_PATH - name: Configure goose run: | mkdir -p ~/.config/goose cat < ~/.config/goose/config.yaml GOOSE_PROVIDER: REPLACE_WITH_PROVIDER GOOSE_MODEL: REPLACE_WITH_MODEL keyring: false EOF ``` #### Pinning goose versions in CI/CD In CI/CD, we recommend pinning a specific goose version with `GOOSE_VERSION` for reproducible runs. This also avoids 404 errors when downloading the goose CLI binary assets if the `stable` release tag doesn’t include them. Relevant installer options for CI: - `GOOSE_VERSION`: the version to pin the install to (both `1.21.1` and `v1.21.1` formats are supported) - `GOOSE_BIN_DIR`: install directory (make sure this directory is on `PATH`) - `CONFIGURE=false`: skip interactive `goose configure` flow
**Replacements** Replace `REPLACE_WITH_VERSION`, `REPLACE_WITH_PROVIDER`, and `REPLACE_WITH_MODEL` with the goose version you want to pin and your LLM provider/model names. Add any other necessary configuration required.
### 4. Gather PR Changes and Prepare Instructions This step extracts pull request details and formats them into structured instructions for goose. ```yaml - name: Create instructions for goose run: | cat < instructions.txt Create a summary of the changes provided. Don't provide any session or logging details. The summary for each file should be brief and structured as: - dot points of changes You don't need any extensions, don't mention extensions at all. The changes to summarise are: $(cat changes.txt) EOF ``` ### 5. Run goose and Clean Output Now, run goose with the formatted instructions and clean the output by removing ANSI color codes and unnecessary log messages. ```yaml - name: Run goose and filter output run: | goose run --instructions instructions.txt | \ # Remove ANSI color codes sed -E 's/\x1B\[[0-9;]*[mK]//g' | \ # Remove session/logging lines grep -v "logging to /home/runner/.config/goose/sessions/" | \ grep -v "^starting session" | \ grep -v "^Closing session" | \ # Trim trailing whitespace sed 's/[[:space:]]*$//' \ > pr_comment.txt ``` ### 6. Post Comment to PR Finally, post the goose output as a comment on the pull request: ```yaml - name: Post comment to PR run: | cat -A pr_comment.txt gh pr comment $PR_NUMBER --body-file pr_comment.txt ``` With this workflow, goose will run on pull requests, analyze the changes, and post a summary as a comment on the PR. This is just one example of what's possible. Feel free to modify your GitHub Action to meet your needs. --- ## Running Multiple goose Instances in Parallel goose supports running multiple concurrent sessions with isolated state, making it safe to run parallel jobs in your CI/CD pipeline. Each goose instance maintains its own conversation history, agent context, and extension configurations without interference. This enables use cases like matrix builds across different environments or processing multiple components simultaneously. --- ## Security Considerations When running goose in a CI/CD environment, keep these security practices in mind: 1. **Secret Management** - Store your sensitive credentials (like API keys) as GitHub Secrets. - Never expose these credentials in logs or PR comments. 2. **Principle of Least Privilege** - Grant only the necessary permissions in your workflow and regularly audit them. 3. **Input Validation** - Ensure any inputs passed to goose are sanitized and validated to prevent unexpected behavior.