Guides
CI/CD Agent Gates
Use a repo-tracked AgentClash CI manifest to define which agent revision, workload, baseline, and gate a pull request should run.
AgentClash CI should gate an agent revision, not only a prompt diff.
Prompt-focused tools can usually watch prompts/** and rerun a prompt eval. AgentClash's main product model is richer: an agent change can touch instructions, workflow code, tool bindings, model aliases, runtime limits, output schemas, guardrails, or retrieval configuration. The CI contract therefore needs to name the candidate agent build, deployment settings, challenge workload, baseline, and gate policy explicitly.
The manifest is the contract
Create a repo-tracked manifest:
agentclash ci init .agentclash/ci.yaml
agentclash ci validate .agentclash/ci.yaml
agentclash ci should-run --changed-file prompts/system.md --json
The generated manifest has this shape:
version: 1
trigger:
paths:
- .agentclash/agent.json
- prompts/**
- tools/**
labels:
- agentclash/eval
candidate:
build:
agent_build_id: 00000000-0000-0000-0000-000000000001
spec_file: .agentclash/agent.json
deployment:
name: pr-candidate
runtime_profile_id: 00000000-0000-0000-0000-000000000002
provider_account_id: 00000000-0000-0000-0000-000000000003
model_alias_id: 00000000-0000-0000-0000-000000000004
evaluation:
challenge_pack_version_id: 00000000-0000-0000-0000-000000000005
input_set_id: 00000000-0000-0000-0000-000000000006
regression_suites:
- 00000000-0000-0000-0000-000000000007
baseline:
run_id: 00000000-0000-0000-0000-000000000008
gate:
fail_on: regression
regressions:
promote_failures: proposed
The IDs in the generated file are placeholders. Replace them with workspace resources before using the manifest for a real gate.
What each section means
triggersays which repository paths and optional labels should cause the workflow to run.candidate.buildnames the existing AgentClash build and the source-backed build-version spec to test.candidate.deploymentnames the runtime resources used for the candidate deployment.evaluationnames the workload: challenge pack version, optional input set, and optional regression suites or cases.baselinenames the locked reference run or deployment.gatenames the release-gate failure threshold.regressionscontrols whether failed cases should only be reported, proposed for promotion, or eventually auto-promoted on main.
The important distinction is:
agent build/deployment = thing under test
challenge pack/regression suite = workload used to test it
release gate = decision policy
If you are deciding what the workload should contain, use CI/CD Workload Recipes for coding, research, support/ops, and long-horizon agent patterns.
Decide whether CI should run
Use agentclash ci should-run when you want AgentClash to explain whether a pull request touches the agent contract. A matching path or label produces should_run: true; unrelated docs-only changes produce should_run: false.
agentclash ci should-run \
--manifest .agentclash/ci.yaml \
--changed-file prompts/system.md
Labels can force the gate even when paths do not match:
agentclash ci should-run \
--manifest .agentclash/ci.yaml \
--changed-file docs/readme.md \
--labels agentclash/eval \
--json
For local or GitHub Actions diffing, pass refs explicitly:
agentclash ci should-run \
--manifest .agentclash/ci.yaml \
--base origin/main \
--head HEAD \
--json
GitHub Actions sketch
The first shipped CLI surface validates the manifest. Full orchestration will be a follow-up command built on the same file. Until then, teams can validate the contract and keep using the existing explicit run and gate commands. The workflow below repeats selected manifest IDs as GitHub variables only because agentclash ci run does not exist yet; once it does, the manifest should be the single source of truth.
name: AgentClash gate
on:
pull_request:
paths:
- ".agentclash/**"
- "prompts/**"
- "tools/**"
jobs:
agentclash:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: "22"
- run: npm i -g agentclash
- name: Validate AgentClash CI manifest
run: agentclash ci validate .agentclash/ci.yaml
- name: Decide whether AgentClash gate should run
id: should-run
run: |
SHOULD_RUN=$(agentclash ci should-run --json | jq -r '.should_run')
echo "should_run=$SHOULD_RUN" >> "$GITHUB_OUTPUT"
- name: Create candidate run
if: steps.should-run.outputs.should_run == 'true'
id: candidate
run: |
RUN_JSON=$(agentclash run create \
--challenge-pack-version "$AGENTCLASH_CHALLENGE_PACK_VERSION" \
--deployments "$AGENTCLASH_CANDIDATE_DEPLOYMENT" \
--json)
echo "run_id=$(echo "$RUN_JSON" | jq -r '.id')" >> "$GITHUB_OUTPUT"
env:
AGENTCLASH_API_URL: https://api.agentclash.dev
AGENTCLASH_TOKEN: ${{ secrets.AGENTCLASH_TOKEN }}
AGENTCLASH_WORKSPACE: ${{ secrets.AGENTCLASH_WORKSPACE }}
AGENTCLASH_CHALLENGE_PACK_VERSION: ${{ vars.AGENTCLASH_CHALLENGE_PACK_VERSION }}
AGENTCLASH_CANDIDATE_DEPLOYMENT: ${{ vars.AGENTCLASH_CANDIDATE_DEPLOYMENT }}
- name: Evaluate release gate
if: steps.should-run.outputs.should_run == 'true'
run: |
agentclash compare gate \
--baseline "$AGENTCLASH_BASELINE_RUN" \
--candidate "${{ steps.candidate.outputs.run_id }}"
env:
AGENTCLASH_API_URL: https://api.agentclash.dev
AGENTCLASH_TOKEN: ${{ secrets.AGENTCLASH_TOKEN }}
AGENTCLASH_WORKSPACE: ${{ secrets.AGENTCLASH_WORKSPACE }}
AGENTCLASH_BASELINE_RUN: ${{ vars.AGENTCLASH_BASELINE_RUN }}
Regression promotion policy
Do not auto-promote every PR failure by default. A bad run, flaky dependency, or weak evaluator could pollute the regression suite.
Use this conservative progression:
regressions:
promote_failures: disabled
Report failures only.
regressions:
promote_failures: proposed
Record promotion candidates for review.
regressions:
promote_failures: auto_on_main
Only a future main-branch workflow should auto-promote high-confidence failures after the gate has proven useful.
Current limits
agentclash ci validatevalidates the manifest shape locally; it does not check that IDs exist in the API.agentclash ci should-runonly decides whether a gate should run; it does not create runs or evaluate gates.- There is not yet an
agentclash ci runwrapper that creates the candidate build version, deployment, run, gate, and PR report in one command. - PR metadata such as repository, pull request number, branch, and commit SHA is not yet attached to runs by the CLI.
- Automatic regression promotion should remain opt-in and conservative.