DeployBrief DeployBrief
← Back to Documentation

Pipeline Presets

Set up pipeline presets for one-click deployment brief generation with predefined pipelines and templates.

What are Pipeline Presets?

Pipeline presets are saved configurations that link Azure DevOps pipelines with specific brief templates. They enable one-click brief generation without manually selecting pipelines and templates each time. Perfect for frequently deployed pipelines like production releases.

Example: Create a "Production API Deploy" preset that uses your "API Production" pipeline with your "Standard Deployment Brief" template. Click one button to generate the brief.

Creating a Preset

  1. Navigate to Settings → Presets in DeployBrief
  2. Click Create Preset
  3. Configure your preset:
    • Name: Descriptive name (e.g., "Production Web App")
    • Description: Optional details about the preset
    • Connection: Select your Azure DevOps connection
    • Project: Choose the Azure DevOps project
    • Pipeline: Select the specific pipeline
    • Template: Choose a brief template (optional)
  4. Click Save Preset

Example Configuration:

Name: Production API Deployment
Description: Main API production pipeline
Connection: Production ADO
Project: MyCompany.Api
Pipeline: api-production-deploy
Template: Standard Production Brief

Using Presets

Once created, presets appear on your dashboard and briefs page for quick access:

From Dashboard

  1. Go to your Dashboard (/app)
  2. Find the "Quick Generate" section
  3. Click on any preset card
  4. Select the build/run number
  5. Click Generate Brief

From Briefs Page

  1. Navigate to Briefs
  2. Click Generate from Preset
  3. Select your preset from the dropdown
  4. Choose build/run number
  5. Click Generate

Time Saver: Presets reduce brief generation from 5+ clicks to 2 clicks!

Managing Presets

Editing Presets

Update preset configuration at any time:

  1. Go to Settings → Presets
  2. Find the preset to edit
  3. Click Edit
  4. Update fields as needed
  5. Click Save

Deleting Presets

Remove presets you no longer need:

  1. Go to Settings → Presets
  2. Find the preset to delete
  3. Click Delete
  4. Confirm deletion

Note: Deleting a preset doesn't affect previously generated briefs. Only future brief generation is impacted.

Duplicating Presets

Create similar presets quickly:

  1. Find an existing preset
  2. Click Duplicate
  3. Modify the name and settings
  4. Save the new preset

Common Preset Patterns

Here are recommended presets for different scenarios:

Production Deployments

Create presets for each production service (API, Web, Workers). Use detailed templates with rollback plans.

Example: "Prod API", "Prod Web Frontend", "Prod Background Jobs"

Staging/QA Environments

Simplified briefs focusing on changes and test results. Less formal than production.

Example: "Staging API", "QA Environment"

Hotfix Deployments

Expedited briefs highlighting the specific issue being fixed and affected users.

Example: "Production Hotfix"

Multi-Service Releases

Separate presets for each service in a coordinated release. Use consistent template.

Example: "v2.5 API", "v2.5 Web", "v2.5 Mobile API"

Client-Specific Deployments

For multi-tenant systems, create presets per client with client-specific templates.

Example: "Client A Production", "Client B Production"

Using Presets via API

Presets can be used programmatically via the DeployBrief API for automated brief generation:

POST /api/briefs/generate-from-preset

{
  "presetId": "12345678-1234-1234-1234-123456789abc",
  "buildId": "2024.12.13.1"
}

Response includes the generated brief:

{
  "briefId": "brief-abc-123",
  "presetName": "Production API Deployment",
  "pipelineName": "api-production-deploy",
  "buildNumber": "2024.12.13.1",
  "status": "success",
  "content": "# Deployment Brief...",
  "createdAt": "2024-12-13T10:30:00Z"
}

See API Documentation for complete details.

Best Practices

  • ✓ Use descriptive names: Include environment and service name
  • ✓ Organize by frequency: Create presets for your most common deployments
  • ✓ Match templates to environment: Production needs more detail than staging
  • ✓ Review regularly: Archive or delete unused presets
  • ✓ Document special cases: Use preset descriptions for unusual configurations
  • ✓ Test after changes: Verify presets after updating pipelines or templates
  • ✓ Share with team: Presets are workspace-wide; create ones others can use

Troubleshooting

Preset Not Appearing

  • Check that your Azure DevOps connection is active
  • Verify the pipeline still exists in Azure DevOps
  • Ensure you have permissions to view the pipeline

Brief Generation Fails

  • Confirm the build/run number exists
  • Check template placeholders are valid
  • Test the connection in Settings → Connections
  • Review error message for specific details

No Builds Available

  • Ensure pipeline has completed runs
  • Check PAT has "Build (Read)" scope
  • Verify you selected the correct project

Next Steps