afv-library/skills/developing-agentforce/references/deploy-reference.md
Steve Hetzel fb4bac9cf0
feat: replace agentforce-development skill with three specialized skills @W-21937872@ (#184)
feat: replace agentforce-development skill with three specialized skills

Replace the monolithic agentforce-development skill with three focused skills:
- developing-agentforce: For creating and authoring Agentforce agents
- observing-agentforce: For monitoring and debugging agents
- testing-agentforce: For validating agent behavior

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-04-09 17:04:48 +05:30

135 lines
4.8 KiB
Markdown

# Deploy -- Bundle Publication Reference
> Extracted from SKILL.md Section 18. This file is loaded on demand when deployment details are needed.
## Overview
Full deployment lifecycle for Agentforce agents: validate, deploy metadata, publish bundle, and activate.
## Usage
```bash
# Validate + publish
sf agent publish authoring-bundle --json --api-name MyAgent -o <org-alias>
# Activate after publish
sf agent activate --json --api-name MyAgent -o <org-alias>
```
## Deployment Phases
### Phase 0: Safety Gate (Required)
Read the `.agent` file and run safety review (see `safety-review-reference.md`). If any BLOCK finding exists, STOP deployment. WARN findings must be reported and acknowledged by the user before proceeding.
### Phase 1: Pre-Deployment Validation
```bash
sf agent validate authoring-bundle --json --api-name MyAgent -o <org-alias>
```
### Phase 1b: Target Dependency Check
Verify all flow/apex targets exist in the org before publishing. If missing, scaffold and deploy them first.
### Phase 2: Deploy Supporting Metadata
```bash
sf project deploy start --json --source-dir force-app -o <org-alias>
```
### Phase 3: Publish Agent Bundle
```bash
sf agent publish authoring-bundle --json --api-name MyAgent -o <org-alias>
```
4-step process: Validate (~1-2s) -> Publish (~8-10s) -> Retrieve (~5-7s) -> Deploy (~4-6s)
### Phase 4: Activate Agent
```bash
sf agent activate --json --api-name MyAgent -o <org-alias>
```
Note: `sf agent activate` may not support `--json` in all CLI versions. If it returns plain text, check for "successfully activated" in the output.
Publishing creates an **inactive** version. Without activation, preview fails with "No valid version available".
## Deploy vs Publish
| What changes | `sf project deploy start` | `sf agent publish authoring-bundle` |
|---|---|---|
| Bundle metadata | Yes | Yes |
| `system: instructions:` | Yes (via activate) | Yes |
| `reasoning: actions:` (transitions + invocations) | **NO** | Yes |
**Always prefer `sf agent publish authoring-bundle`.** If you change `reasoning: actions:`, publish is required.
## Common Errors
| Error | Cause | Fix |
|-------|-------|-----|
| `Required fields missing: [BundleType]` | Extra fields in bundle-meta.xml | Use minimal: only `<bundleType>AGENT</bundleType>` |
| `Internal Error, try again later` | Invalid default_agent_user or new agent platform bug | Query Einstein Agent Users; for new agents, create shell in Setup UI first |
| `Duplicate value found: GenAiPluginDefinition` | `start_agent` and `topic` share name | Use different names |
| `Flow not found` | Metadata not deployed | Deploy flows before publishing |
| `SetupEntityType is not supported for DML` | PermissionSet via Apex DML | Use Metadata API (`sf project deploy start`) |
## Rollback
```bash
sf agent deactivate --json --api-name MyAgent -o <org>
sf data query --json --query "SELECT Id, VersionNumber FROM BotVersion WHERE BotDefinition.DeveloperName = 'MyAgent' ORDER BY VersionNumber DESC LIMIT 2" -o <org>
sf agent activate --json --api-name MyAgent --version-number <previous> -o <org>
```
## CI/CD Integration
```yaml
name: Deploy Agentforce Agent
on:
push:
branches: [main]
paths: ['force-app/**']
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install SF CLI
run: npm install -g @salesforce/cli
- name: Auth
run: |
echo "${{ secrets.SFDX_AUTH_URL }}" > auth.txt
sf org login sfdx-url --sfdx-url-file auth.txt --alias production
- name: Validate
run: sf agent validate authoring-bundle --json --api-name ${{ vars.AGENT_NAME }} -o production
- name: Deploy Metadata
run: sf project deploy start --json --source-dir force-app -o production
- name: Publish
run: sf agent publish authoring-bundle --json --api-name ${{ vars.AGENT_NAME }} -o production
- name: Activate
if: github.ref == 'refs/heads/main'
run: sf agent activate --json --api-name ${{ vars.AGENT_NAME }} -o production
```
## Pre-Deployment Checklist
- [ ] All action targets exist in org (run discover first)
- [ ] Agent Script validated (no syntax errors)
- [ ] Einstein Agent User configured correctly
- [ ] Supporting metadata deployed
- [ ] Previous version backed up
- [ ] Rollback plan documented
## Post-Deployment Testing
```bash
sf agent preview start --json --use-live-actions --authoring-bundle MyAgent -o <org>
# Read sessionId from the JSON response, then:
sf agent preview send --json --authoring-bundle MyAgent --session-id <SESSION_ID> -u "Hello, I need help" -o <org>
sf agent preview end --json --authoring-bundle MyAgent --session-id <SESSION_ID> -o <org>
```
## Exit Codes
| Code | Meaning |
|------|---------|
| 0 | Success |
| 1 | Validation/deployment failed |
| 2 | Critical failure |