Skip to content

Release Notes

Release Notes for Salesforce CI/CD

Automatically generate release notes that document what changed, who contributed, which tickets were resolved, and what metadata was added, modified, or deleted - directly from your Git history and ticketing system.

Command: sf hardis:doc:release-notes

What it generates

A comprehensive release notes document that includes:

Section Description Source
AI Summary Structured summary with features, fixes, and statistics AI Provider (optional)
Tickets Referenced tickets with status, assignee, and link to ticketing system Ticket Provider (JIRA, Azure Boards)
Pull Requests Merged PRs with title, author, and merge date Git Provider
Contributors List of PR authors with contribution count Git Provider
Metadata Changes Created, modified, and deleted metadata items grouped by type sfdx-git-delta
Deployment Actions Manual tasks and automated actions with execution status and PR links PR comments / action YAML files

Output formats

  • Markdown (.md) - always generated
  • PDF (.pdf) - generated by default, skip with --no-pdf
  • XLSX (.xlsx) - multi-tab spreadsheet with Tickets, Pull Requests, Metadata Changes, and Deployment Actions tabs

Two modes

Mode Use case How scope is determined
prepare Preview what will be included in the next release Finds an open PR to the target branch, or computes the hypothetical delta
post Document a completed release Uses merged PRs and git tags / branch history

Scope resolution

The command supports several ways to define the release scope:

  • Git tags (semver): --release-tag v1.2.0 - auto-detects the previous tag
  • Branch-based: --target-branch main - uses the major orgs configuration to find source branches
  • Date range: --from-date 2026-01-01 --to-date 2026-03-31
  • Commit range: --source-commit abc123 --merge-commit def456

Inter-major-branch PRs (e.g., integration to preprod promotions) are automatically excluded since they are not user stories.

Notifications

In post mode, when the release targets a production branch, a notification is sent via your configured messaging platform (Slack, Microsoft Teams, Email) with the PDF and XLSX reports attached.

Usage examples

# Interactive mode - prompts for all missing information
sf hardis:doc:release-notes

# Post-release documentation for a tagged release
sf hardis:doc:release-notes --mode post --release-tag v1.2.0

# Prepare mode - preview what will go into the next production release
sf hardis:doc:release-notes --mode prepare --target-branch main

# Agent mode for CI/CD automation
sf hardis:doc:release-notes --agent --mode post --target-branch main

# Date-based scope without PDF
sf hardis:doc:release-notes --mode post --from-date 2026-01-01 --to-date 2026-03-31 --no-pdf

Example output

Release Notes Example