Writing Release Notes

59 chapters · 270 min

Automated Jira lookups require the bitwarden-atlassian-tools plugin (its MCP server exposes search_issues, get_issue, and get_issue_comments). Without it, or when running in a Claude.ai Project (MCP tools are unavailable there), fall back to asking the user to paste the release page content and the Slack thread text directly — the rest of this skill works identically either way. There is no Slack MCP integration in this marketplace; the Slack thread is always gathered by asking the user to paste it.

Step 1: Gather Inputs

Gather two inputs before writing anything:

1a. Jira Release Page

Ask the user for the Jira release page URL (e.g. https://bitwarden.atlassian.net/projects/CL/versions/12345/tab/release-report-all-issues) or the release version name (e.g. 2025.7.0).

If search_issues is available, resolve the query:

• From a URL, extract the numeric version ID (the segment after /versions/) and query by ID: fixVersion = 12345 ORDER BY issuetype ASC
• From a version name, quote it: fixVersion = "2025.7.0" ORDER BY issuetype ASC

Call search_issues with fields: ["summary", "issuetype", "labels", "components", "status", "description"], and page through results using the returned nextPageToken until none is returned. For each issue, capture summary, issue type, labels, components, status, and any feature flag references found in the description. Feature flag references usually surface more completely in the Slack thread (Step 1b); only call get_issue_comments for individual issues where the flag is ambiguous after checking both sources.

If MCP tools are not available (web app context), ask the user to paste the release page content or a list of ticket summaries directly into the conversation.

1b. #release Slack Thread

The #release Slack thread is posted weekly and specifies which feature flags are toggled for the release. This is critical for two reasons:

• Include: Only user-facing changes whose feature flag is being enabled in this release (or that have no flag) should appear in the notes.
• Server releases — flag removals: When a feature flag is being fully removed from the server codebase, this signals that self-hosted users are gaining access to the feature. These must appear in the release notes.

Ask the user to paste the thread content.

Parse the thread to extract:

• Release version and date
• List of flags being enabled for this release (per platform if specified)
• List of flags being removed (for server releases — capture both the flag identifier and any associated feature description from the ticket or thread)
• Any PM or engineering notes about what to highlight or suppress

Step 2: Determine Release Scope

Identify:

• Which repo/product is being released (clients, server, mobile, browser extension, CLI, desktop)
• Which platforms are covered (web app, desktop, browser extension, mobile iOS, mobile Android, CLI)
• Release version number

If the release covers multiple repos with separate release notes (e.g., clients and server each have their own GitHub release), confirm with the user whether they want notes for all or one.

Step 3: Filter to User-Facing Changes

Go through every issue in the release and classify it. Only items that pass the filter appear as named bullet points.

Include as a named bullet point

• New user-visible features or capabilities
• UI or UX changes users will notice
• Policy and admin setting changes (including new enforcement options)
• Performance improvements users will perceive
• Significant accessibility improvements
• New onboarding flows, product tours, or setup wizards
• Checkout, billing, or subscription flow changes
• Items whose feature flag is confirmed enabled in this release’s Slack thread

Collapse into the catch-all line

• Internal refactors, code cleanup, or architecture changes with no user-visible effect
• Dependency upgrades with no user-visible change
• Test coverage additions
• Logging, telemetry, or analytics instrumentation
• Items behind a feature flag that is not being enabled in this release
• Minor copy or label tweaks not worth their own bullet
• Bug fixes that are too narrow or edge-case to be meaningful to most users

Always include (never collapse) — server releases only

Feature flags that are fully removed from the server codebase in this release. Flag removal is the moment self-hosted users gain access to a feature. Write each removal as a user-facing line describing what the feature does — not the internal flag identifier. See Step 4 for format.

Exclude entirely

• Security fixes, unless the Slack thread or the user explicitly approves specific wording for one (default to excluding all security fixes from named bullets)
• Internal tooling changes with zero user impact
• Duplicate or reverted changes

Step 4: Write the Release Notes

Format rules

• Plain text only — no markdown, no asterisks, no headers, no bullet characters
• One line per notable change
• Begin each line with a past-tense action verb: Added, Updated, Fixed, Improved, Removed
• Write from the user’s perspective — what did they gain, lose, or notice?
• No Jira ticket numbers, no internal terminology, and critically: no feature flag identifiers
• Keep each line under ~12 words
• Aim for 3–7 notable bullet points maximum, followed by one catch-all line
• End with: Various under-the-hood improvements and minor bug fixes

Tone

Informative, brief, benefit-forward. Avoid marketing superlatives (“exciting”, “powerful”). Avoid engineering jargon (“refactored”, “migrated”, “scaffolded”, “deprecated”). Write for a non-technical user who wants to know if anything changed that affects them.

Server flag removals

Flag removal lines describe the feature the flag was guarding, in plain user-facing language. Look up the associated Jira ticket, Confluence page, or Slack thread description to find the right framing. The internal flag name is a lookup key only — it never appears in the output.

Use the format:

Example: a flag named pm-36859-refactor-org-collections-vault-component becomes:

Self-hosted users are the primary audience for this line — they are receiving the feature for the first time when the flag is removed, so the description should communicate the benefit clearly.

Example output (clients release)

Example output (server release with flag removals)

Step 5: Review and Calibrate

Before presenting the final output, check:

• Not done: Every named bullet has its corresponding feature flag enabled in the Slack thread (or has no flag)
• Not done: No internal or infrastructure-only changes appear as named bullets
• Not done: Server releases include a line for every flag removal mentioned in the Slack thread, written in user-facing language
• Not done: No internal flag identifiers appear anywhere in the output
• Not done: Total named bullets are between 3 and 7 (if more than 7 are equally important, consolidate similar items)
• Not done: The catch-all line is present
• Not done: No markdown formatting in the output text