DeployBrief DeployBrief
← Back to Documentation

Getting Started

Set up DeployBrief and generate your first deployment brief in minutes.

1

Create Your Account

DeployBrief uses Microsoft authentication for secure access.

  1. Navigate to deploybrief.com/login
  2. Click "Sign in with Microsoft"
  3. Authenticate with your Microsoft account (work, school, or personal)
  4. Grant the requested permissions

After signing in, you'll be redirected to the DeployBrief dashboard at /app.

2

Connect Azure DevOps

To generate deployment briefs, you need to connect your Azure DevOps organization.

Create a Personal Access Token (PAT)

  1. Go to dev.azure.com
  2. Click your profile icon → Personal access tokens
  3. Click New Token
  4. Configure the token:
    • Name: DeployBrief
    • Organization: Select your organization
    • Expiration: Choose duration (90 days recommended)
    • Scopes: Select Read permissions for:
      • Build
      • Release
      • Work Items
      • Code
      • Test Management
  5. Click Create and copy the token immediately

Important: Save your PAT securely. You won't be able to view it again. DeployBrief encrypts and stores PATs securely.

Add Connection in DeployBrief

  1. In DeployBrief, navigate to Integrations → Azure DevOps
  2. Click Add Connection
  3. Enter:
    • Organization Name: Your Azure DevOps organization (e.g., "contoso")
    • Personal Access Token: Paste the PAT you created
  4. Click Test Connection to verify
  5. Click Save

You can connect multiple Azure DevOps organization if needed.

3

Generate Your First Brief

Now you're ready to create a deployment brief.

  1. Navigate to Briefs in the main menu
  2. Click Generate New Brief
  3. Select your pipeline configuration:
    • Organization: Choose the Azure DevOps organization
    • Project: Select the project
    • Pipeline Type: Choose Build or Release
    • Pipeline: Select the specific pipeline
    • Run/Release: Choose the specific deployment
  4. Click Generate Brief
  5. Wait while DeployBrief retrieves and formats your deployment data

Brief generation typically takes 5-15 seconds depending on the amount of data.

4

Understanding Brief Content

Your deployment brief includes comprehensive information about the deployment:

Deployment Overview

Pipeline name, build/release number, deployment date, and environment

Work Items

User stories, tasks, and bugs included in this deployment with titles, descriptions, and assignees

Pull Requests

Code changes merged for this deployment with PR titles, reviewers, and merge dates

Test Results

Test execution summary showing pass/fail counts, test duration, and test suite details

Code Coverage

Line and branch coverage percentages, showing code quality metrics

You can:

  • View the brief in markdown format
  • Export to PDF for sharing
  • Copy markdown for documentation
  • Regenerate with different templates

Next Steps

Customize Brief Templates

Learn how to create custom templates to match your documentation needs

Set Up Pipeline Presets

Speed up brief generation with reusable pipeline configurations

Integrate with CI/CD

Automate brief generation from your deployment pipelines