Release Blocker Issue Template

Release Blocker Issue Template

Release blockers are issues that must be resolved before a version can be shipped. A dedicated template ensures these critical issues are immediately visible and contain all the context needed for rapid resolution.

Template Structure

name: "Release Blocker"
description: "Flag an issue that blocks the next release"
title: "[Release Blocker]: "
labels: ["release-blocker", "priority:critical"]
body:
  - type: markdown
    attributes:
      value: |
        **This template is for issues that must be resolved before the
        next release can ship.** Please confirm this truly blocks the
        release before filing.
  - type: input
    id: target_release
    attributes:
      label: "Target Release"
      description: "Which release version is blocked?"
      placeholder: "v3.0.0"
    validations:
      required: true
  - type: textarea
    id: blocking_reason
    attributes:
      label: "Why This Blocks the Release"
      description: "Explain why this must be fixed before shipping"
    validations:
      required: true
  - type: dropdown
    id: workaround
    attributes:
      label: "Workaround Available?"
      options:
        - "No workaround exists"
        - "Workaround exists but is unacceptable for release"
        - "Workaround exists and is documented"
    validations:
      required: true
  - type: input
    id: deadline
    attributes:
      label: "Release Deadline"
      description: "When is the release scheduled?"
      placeholder: "2024-03-15"
    validations:
      required: true
  - type: textarea
    id: proposed_fix
    attributes:
      label: "Proposed Fix"
      description: "If known, describe the fix approach and estimated effort"
    validations:
      required: false

Automatic Labels and Notifications

The release-blocker and priority:critical labels enable automatic notifications to release managers. Consider adding a GitHub Actions workflow that posts to Slack when issues with the release-blocker label are created.

Workaround Field

The workaround dropdown is deliberately structured to differentiate between "no workaround" (true blocker) and "workaround exists but unacceptable" (quality gate). This helps release managers make ship/no-ship decisions.

Linking to Milestones

Encourage reporters to add the issue to the relevant milestone using GitHub's milestone feature, making it visible in release planning views.