Skip to content

Add release drafter workflow#49

Merged
tangrufus merged 1 commit into
mainfrom
add-release-drafter-workflow
Apr 11, 2026
Merged

Add release drafter workflow#49
tangrufus merged 1 commit into
mainfrom
add-release-drafter-workflow

Conversation

@tangrufus
Copy link
Copy Markdown
Member

No description provided.

@tangrufus tangrufus added the enhancement New feature or request label Apr 11, 2026
Copilot AI review requested due to automatic review settings April 11, 2026 19:17
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to add Release Drafter automation to generate release notes based on merged PR labels.

Changes:

  • Adds a new .github/workflows/release-drafter.yml file intended to configure Release Drafter categories, templates, and version resolution.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/release-drafter.yml Outdated
Comment on lines +1 to +101
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'

template: |
# What's Changed

$CHANGES

**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

categories:
- title: ':sparkles: New Features & Enhancements'
labels:
- enhancement
- enhancements
- feature
- features
- improvement
- improvements

- title: ':boom: Breaking'
labels:
- breaking

- title: ':fire: Removed'
labels:
- remove
- removed

- title: ':wastebasket: Deprecated'
labels:
- deprecate
- deprecated

- title: ':lock: Security'
labels:
- security

- title: ':bug: Bug Fixes'
labels:
- bug
- bugs

- title: ':jigsaw: Miscellaneous'
labels:
- miscellaneous

- title: ':memo: Documentation'
labels:
- doc
- docs
- documentation
- readme

- title: ':white_check_mark: Tests'
collapse-after: 3
labels:
- test
- tests

- title: ':wrench: Maintenance'
collapse-after: 3
labels:
- chore
- config
- maintenance

- title: ':pencil2: Typos'
collapse-after: 3
labels:
- typo
- typos

- title: ':robot: Automated'
collapse-after: 3
labels:
- tastendruck

- title: '️:arrow_up: Dependencies'
collapse-after: 3
labels:
- dependencies # Default label used by Dependabot

exclude-labels:
- invalid
- revert
- reverted
- 'skip release'
- skip_release
- skip-release

version-resolver:
major:
labels:
- breaking
- major
minor:
labels:
- enhancement
- minor
default: patch
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is placed under .github/workflows/, but its contents are Release Drafter configuration (e.g., name-template, categories) rather than a GitHub Actions workflow (missing required on: and jobs: keys). As-is, GitHub will treat it as an invalid workflow and CI actionlint will likely fail. Move this config to .github/release-drafter.yml (there is already one in the repo—merge the desired changes there), and create a proper workflow in .github/workflows/release-drafter.yml that runs release-drafter/release-drafter and points configuration-path at the config file (pin the action to a commit SHA to match repo conventions).

Suggested change
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
template: |
# What's Changed
$CHANGES
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
categories:
- title: ':sparkles: New Features & Enhancements'
labels:
- enhancement
- enhancements
- feature
- features
- improvement
- improvements
- title: ':boom: Breaking'
labels:
- breaking
- title: ':fire: Removed'
labels:
- remove
- removed
- title: ':wastebasket: Deprecated'
labels:
- deprecate
- deprecated
- title: ':lock: Security'
labels:
- security
- title: ':bug: Bug Fixes'
labels:
- bug
- bugs
- title: ':jigsaw: Miscellaneous'
labels:
- miscellaneous
- title: ':memo: Documentation'
labels:
- doc
- docs
- documentation
- readme
- title: ':white_check_mark: Tests'
collapse-after: 3
labels:
- test
- tests
- title: ':wrench: Maintenance'
collapse-after: 3
labels:
- chore
- config
- maintenance
- title: ':pencil2: Typos'
collapse-after: 3
labels:
- typo
- typos
- title: ':robot: Automated'
collapse-after: 3
labels:
- tastendruck
- title: '️:arrow_up: Dependencies'
collapse-after: 3
labels:
- dependencies # Default label used by Dependabot
exclude-labels:
- invalid
- revert
- reverted
- 'skip release'
- skip_release
- skip-release
version-resolver:
major:
labels:
- breaking
- major
minor:
labels:
- enhancement
- minor
default: patch
name: Release Drafter
on:
push:
branches:
- main
pull_request:
types:
- opened
- reopened
- synchronize
- labeled
- unlabeled
permissions:
contents: read
pull-requests: write
jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- name: Draft release notes
uses: release-drafter/release-drafter@<PINNED_COMMIT_SHA>
with:
configuration-path: .github/release-drafter.yml
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Copilot uses AI. Check for mistakes.
@tangrufus tangrufus force-pushed the add-release-drafter-workflow branch from e44c7b5 to d6a41e5 Compare April 11, 2026 19:24
@tangrufus tangrufus force-pushed the add-release-drafter-workflow branch from d6a41e5 to badc8ee Compare April 11, 2026 19:24
@tangrufus tangrufus enabled auto-merge (squash) April 11, 2026 19:25
@tangrufus tangrufus merged commit 191eb7a into main Apr 11, 2026
2 checks passed
@tangrufus tangrufus deleted the add-release-drafter-workflow branch April 11, 2026 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Development

Successfully merging this pull request may close these issues.

2 participants