Dependency Update Issue Template

Dependency Update Issue Template

Tracking dependency updates through issues helps teams evaluate the impact, plan migrations, and document breaking changes. This template standardizes the information needed for dependency decisions.

Template Structure

name: "Dependency Update"
description: "Request or track a dependency update"
title: "[Deps]: "
labels: ["dependencies"]
body:
  - type: input
    id: package_name
    attributes:
      label: "Package Name"
      placeholder: "e.g., react, lodash, express"
    validations:
      required: true
  - type: input
    id: current_version
    attributes:
      label: "Current Version"
      placeholder: "e.g., 17.0.2"
    validations:
      required: true
  - type: input
    id: target_version
    attributes:
      label: "Target Version"
      placeholder: "e.g., 18.2.0"
    validations:
      required: true
  - type: dropdown
    id: update_type
    attributes:
      label: "Update Type"
      options:
        - "Patch (bug fix)"
        - "Minor (new features, backward compatible)"
        - "Major (breaking changes)"
        - "Security fix"
    validations:
      required: true
  - type: textarea
    id: breaking_changes
    attributes:
      label: "Breaking Changes"
      description: "List any breaking changes from the changelog"
    validations:
      required: false
  - type: textarea
    id: migration_notes
    attributes:
      label: "Migration Notes"
      description: "Steps needed to migrate to the new version"
    validations:
      required: false
  - type: checkboxes
    id: checklist
    attributes:
      label: "Pre-update Checklist"
      options:
        - label: "Reviewed changelog"
        - label: "Checked for breaking changes"
        - label: "Tested locally"
        - label: "Updated related dependencies"

Why Track Dependency Updates as Issues?

Many teams use Dependabot or Renovate for automated PRs, but major version upgrades often require planning. An issue template allows:

• Documenting the rationale for or against upgrading
• Tracking breaking changes and required code modifications
• Coordinating cross-team updates for shared dependencies
• Creating a migration plan before starting the work

Security Update Priority

When the update type is "Security fix", consider automatically applying additional labels like priority:high and security to ensure rapid response.