Skip to main content
← Back to workflows

How to Draft Release Notes with GitHub Actions?

release-drafter/release-drafter -
GitHub Action
v6.0.0
3,226
Contributors
Contributor - toolmantimContributor - jetersen
CICUBE ANALYTICS INSIGHTS
Engineering Velocity: 25% Team Time Lost to CI Issues
View Platform →
3.5h
Time Saved/Dev/Week
40%
Faster Releases
Click for next insight
Usage
name: Release Drafter
on:
push:
branches:
- master
pull_request:
types: [opened, reopened, synchronize]
permissions:
contents: read
jobs:
update_release_draft:
permissions:
contents: write
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v6
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

release-drafter logo

release-drafter

Drafts your next release notes as pull requests are merged into master.


What is Release Drafter?

Release Drafter is a GitHub Action that automatically drafts your next release notes as pull requests are merged into the master branch. This tool is built with Probot and doesn’t require installation on our local machines.

Why Should We Use It?

  • Automation of Release Notes: Automatically keeps the draft of your release notes updated as new pull requests are merged.
  • Clean and Structured: Helps maintain a clear and organized changelog.
  • Customizable: Allows extensive configuration to tailor the draft releases according to our project needs.