release-drafter.md

Release Drafter

.github/workflows/release-drafter.yaml

This workflow creates a draft release with auto-generated release notes. It finds the latest semver tag, calculates the next version based on the bump type, creates and pushes a new tag, and creates a draft release using GitHub's release notes generation.

Usage

name: Release Drafter

on:
  workflow_dispatch:
    inputs:
      bump_type:
        description: 'Version bump type [MAJOR.MINOR.PATCH]'
        type: choice
        required: true
        default: 'patch'
        options:
          - patch
          - minor
          - major
      publish_release:
        description: 'Publish release immediately'
        type: boolean
        default: false
      is_prerelease:
        description: 'Mark as is_prerelease'
        type: boolean
        default: false

jobs:
  release:
    name: Create Release Draft
    permissions:
      contents: write
    uses: significa/actions/.github/workflows/release-drafter.yaml@main
    with:
      bump_type: ${{ inputs.bump_type }}
      publish_release: ${{ inputs.publish_release }}
      is_prerelease: ${{ inputs.is_prerelease }}

Inputs

• bump_type: Version bump type - patch (default), minor, or major
• publish_release: Publish release immediately instead of creating a draft (default: false)
• is_prerelease: Mark the release as a is_prerelease (default: false)

Permissions required

• contents: write - To create tags and releases