warpdotdev/oz-agent-action

Profil warpdotdev

Dernière activité source enregistrée: 1 juin 2026 à 18:28

Catalogue SkillsMP mis à jour: 17 octobre 2026 à 00:09

skills collectés: 2

Étoiles GitHub: 120
Forks GitHub: 50

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

# Oz Agent Action This action supports running the Oz Agent in GitHub Actions. It wraps the [Oz CLI](https://docs.warp.dev/developers/cli) with: - Caching for package installation - Capturing output for subsequent steps ## Quickstart To get started, you'll need a [Oz API Key](https://docs.warp.dev/developers/cli#api-key-authentication). We recommend storing this key as a [secret](https://docs.github.com/en/actions/concepts/security/secrets) in your repository or organization. Then, add a step to your workflow that runs Oz: ```yaml - name: Review code changes in Oz uses: warpdotdev/oz-agent-action@v1 with: prompt: | Review the code changes on this branch: 1. Use the `git` command to identify changes from the base branch 2. Thoroughly analyze all changes, and identify any issues with style, security, or correctness 3. If you have suggestions, use the `gh` command to comment on the PR. # Optional: # model: <warp-model-id> # name: "PR review" # mcp: | # {"mcpServers": {"github": {"command": "npx", "args": ["-y", "@modelcontextprotocol/server-github"], "env": {"GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}"}}}} warp_api_key: ${{ secrets.WARP_API_KEY }} ``` ## Running in cloud mode By default, the action runs the agent on the GitHub Actions runner using `oz agent run`. Set `cloud: true` to start an Oz cloud agent using `oz agent run-cloud`: ```yaml - name: Run Oz in cloud mode uses: warpdotdev/oz-agent-action@v1 with: prompt: Review the code changes on this branch cloud: true warp_api_key: ${{ secrets.WARP_API_KEY }} ``` Cloud runs use Warp-hosted workers by default. Set `host` only when routing a cloud run to a self-hosted worker. Cloud runs use no environment by default. Set `environment` to an environment ID when the agent needs a configured environment: ```yaml - name: Run Oz in a cloud environment uses: warpdotdev/oz-agent-action@v1 with: prompt: Review the code changes on this branch cloud: true environment: <environment-id> warp_api_key: ${{ secrets.WARP_API_KEY }} ``` ## Using Skills Skills provide reusable, specialized capabilities for the Oz Agent. You can find a curated set of skills in the [oz-skills](https://github.com/warpdotdev/oz-skills) repository, or create your own. You can use skills instead of or along with prompts: ```yaml - name: Run agent with a skill uses: warpdotdev/oz-agent-action@v1 with: skill: 'my-skill' warp_api_key: ${{ secrets.WARP_API_KEY }} ``` Skill format options: - `skill_name` - Searches for the skill in your repository's skill directories - `repo:skill_name` - Uses a skill from a specific repository - `org/repo:skill_name` - Uses a skill from a specific organization's repository You can combine skills with prompts - the skill provides the base context and the prompt specifies the task: ```yaml with: skill: 'code-review' prompt: 'Focus on security vulnerabilities in authentication code' warp_api_key: ${{ secrets.WARP_API_KEY }} ``` ## Debug Logging By default, the action enables Oz debug logging (`--debug`) only when GitHub requests it — for example, when you [re-run a job with step debug logging enabled](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging). Set the `debug` input to `true` to always enable debug logging, regardless of whether step debug logging is on: ```yaml - name: Run Oz with debug logging uses: warpdotdev/oz-agent-action@v1 with: prompt: Review the code changes on this branch debug: true warp_api_key: ${{ secrets.WARP_API_KEY }} ``` When `debug: true`, Oz logs are emitted on stderr even if the workflow run was not started with step debug logging. When `debug` is `false` (the default), the existing behavior is preserved: debug logging activates only when GitHub's step-debug signal is on. ## Helpful Tips - Inject relevant context from the GitHub event and previous steps into your Oz prompt via templating. - Oz's output is available as `steps.${step_id}.outputs.agent_output`. Use the `output_format: json` option to get machine-readable agent output! - For debugging, use the `share` option to automatically share the agent's session with your teammates. See the [Session Sharing](https://docs.warp.dev/knowledge-and-collaboration/session-sharing) documentation for more info. See the [action definition](./action.yml) for all options. ## Example Workflows This repository includes several example workflows in `examples/` that demonstrate how to use the Oz Agent Action for common development tasks. Each scenario is provided in three forms: - A **full reference workflow** in `examples/` that shows all jobs, permissions, and steps. - A **reusable workflow** in `.github/workflows/` that can be invoked via `workflow_call` from other workflows. - A **lightweight consumer template** in `consumer-workflows/` that wires the appropriate triggers and calls the reusable workflow via `jobs.<id>.uses`. These templates are intended to be copied into `.github/workflows/` in your own repository and customized. ### How to use the scenario workflows 1. Pick a scenario below (e.g., Respond to Comment, Auto Fix Issue). 2. Copy the corresponding file from `consumer-workflows/` into `.github/workflows/` in your repository. 3. Ensure the required secrets (such as `WARP_API_KEY`, and `SLACK_WEBHOOK_URL` where applicable) are defined in your repository and mapped under the `secrets:` block. Alternatively, advanced users can call the reusable workflows directly from their own workflows via `jobs.<id>.uses` and wire `with:` and `secrets:` manually. ### Respond to Comment _Full Example_: [examples/respond-to-comment.yml](examples/respond-to-comment.yml) _Consumer Template_: [consumer-workflows/respond-to-comment.yml](consumer-workflows/respond-to-comment.yml) **Usage:** Comment on a PR or Issue with `@oz-agent` (or your configured trigger phrase). **Description:** Allows you to interact with the Agent directly in comments (e.g., "@oz-agent fix this typo"). **Setup:** - Ensure `WARP_API_KEY` is set in Repository Secrets. **Expected Output:** - The Agent replies to your comment with an answer or confirmation. - If code changes were requested, the Agent commits them directly to the PR branch. **When to use:** Interactive coding assistance during code review or issue triage. ### Auto PR Review _Full Example_: [examples/review-pr.yml](examples/review-pr.yml) _Consumer Template_: [consumer-workflows/review-pr.yml](consumer-workflows/review-pr.yml) **Usage:** Runs automatically when a Pull Request first becomes reviewable: either a non-draft Pull Request is opened, or an existing draft Pull Request is marked ready for review. Comment `/warp-agent-review` on the Pull Request to request another review. **Description:** Analyzes the PR diff and provides code review feedback. Each re-review focuses on changes since the previous review. **Setup:** - Ensure `WARP_API_KEY` is set in Repository Secrets. - The Agent needs read access to contents and write access to pull-requests. **Expected Output:** - Inline comments on the PR diff highlighting potential bugs, security issues, or style improvements. - A general summary comment if applicable. **When to use:** Get immediate feedback on code changes before human review, then run `/warp-agent-review` again after addressing feedback or adding commits. ### Auto Fix Issue _Full Example_: [examples/auto-fix-issue.yml](examples/auto-fix-issue.yml) _Consumer Template_: [consumer-workflows/auto-fix-issue.yml](consumer-workflows/auto-fix-issue.yml) **Usage:** Apply the label `oz-agent` to any GitHub Issue. **Description:** Triggers when the label is applied, analyzes the issue, and attempts to write code to fix it. **Setup:** - Ensure `WARP_API_KEY` is set in Repository Secrets. - Action requires write permissions for contents, issues, and pull-requests. **Expected Output:** - If a fix is found: A new Pull Request (`fix/issue-NUMBER`) is created and linked to the issue. - If no fix is found: The Agent comments on the issue explaining why. **When to use:** Delegate bug fixes, small features, or chore tasks to the Oz Agent. ### Daily Issue Summary _Full Example_: [examples/daily-issue-summary.yml](examples/daily-issue-summary.yml) _Consumer Template_: [consumer-workflows/daily-issue-summary.yml](consumer-workflows/daily-issue-summary.yml) **Usage:** Runs automatically on a schedule (every day at 9:00 UTC). **Description:** Fetches issues created in the last 24 hours and generates a summary. **Setup:** - Ensure `WARP_API_KEY` is set in Repository Secrets. - Ensure `SLACK_WEBHOOK_URL` is set in Repository Secrets to receive the report. **Expected Output:** A Slack message containing a categorized summary of new issues (Bugs, Features, etc.). **When to use:** Keep your team aligned on incoming issues without manually checking GitHub. ### Fix Failing Checks _Full Example_: [examples/fix-failing-checks.yml](examples/fix-failing-checks.yml) _Consumer Template_: [consumer-workflows/fix-failing-checks.yml](consumer-workflows/fix-failing-checks.yml) **Usage:** Triggers automatically when a specified workflow (e.g., "Continuous Integration") fails. **Description:** Analyzes failure logs from the failed workflow to determine the cause and attempts a fix. **Setup:** - Ensure `WARP_API_KEY` is set in Repository Secrets. - Update the `workflow_run.workflows` list in the file to match your CI workflow names. **Expected Output:** - A new Pull Request containing the fix for the build or test failure. - Comments on the original PR (if applicable) with a link to the fix. **When to use:** Reduce downtime caused by broken builds or flaky tests. ### Suggest Review Fixes _Full Example_: [examples/suggest-review-fixes.yml](examples/suggest-review-fixes.yml) _Consumer Template_: [consumer-workflows/suggest-review-fixes.yml](consumer-workflows/suggest-review-fixes.yml) **Usage:** Runs automatically when a Pull Request review is submitted. **Description:** Analyzes review comments. If a comment requests a simple fix (e.g., typo, naming, style), the Agent replies with a code suggestion block containing the fix. **Setup:** - Ensure `WARP_API_KEY` is set in Repository Secrets. - Action requires write permissions for `contents` and `pull-requests`. **Expected Output:** - Replies to review comments with code suggestions for simple fixes. - Skips complex or unclear comments. **When to use:** Speed up the cycle of applying review feedback for trivial issues.

Chargement du README du dépôt…

Skills dans ce dépôt

Analystes en assurance qualité des logiciels et testeurs Développeurs de logiciels

2 catégories métier · 100% classifié

skill

métier

description

mis à jour

review-pr

Analystes en assurance qualité des logiciels et testeurs

Review a pull request diff and write structured feedback to review.json for the workflow to publish.

Langue du texte source : anglais

2026-06-01

test-skill

Développeurs de logiciels

A simple test skill that validates the GitHub Action can load skills from the repository

Langue du texte source : anglais

2026-02-12

Affichage de 2 skills collectés sur 2.

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/warpdotdev/oz-agent-action.