You can automate release notes on GitHub by letting GitHub write a first draft from your merged pull requests every time you tag a release, and then editing that draft into something your readers can use. The automation removes the blank page. It does not remove the editing.

Here is the setup in three steps, and what the generated text does not do.

Step 1: let GitHub generate the notes

When you draft a release in the GitHub interface, there is a button to generate release notes. GitHub fills the description with a list of the pull requests merged since the previous release, the people who contributed, and a link to the full changelog comparison. The GitHub documentation describes the feature and its options.

The quality of this list follows the quality of your pull request titles. "Add PDF export to reports" reads well in a release. "fix stuff" does not.

Step 2: create the release from a workflow

To stop doing it by hand, create the release from a GitHub Actions workflow that runs when you push a version tag. The GitHub command line tool can generate the notes with one flag:

name: Release on: push: tags: ["v*"] permissions: contents: write jobs: release: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Create the release with generated notes env: GH_TOKEN: ${{ github.token }} run: gh release create "${{ github.ref_name }}" --generate-notes 

The workflow needs permission to write repository contents, which is what the permissions block grants. Push a tag such as v1.4.0 and a release appears with its notes already filled in.

Step 3: group the notes with .github/release.yml

Without configuration, the generated list is flat. A file named .github/release.yml tells GitHub how to group pull requests by label and which ones to leave out:

changelog: exclude: labels: - ignore-for-release categories: - title: New features labels: - enhancement - title: Bug fixes labels: - bug - title: Other changes labels: - "*" 

Pull requests labelled enhancement go under "New features", bug under "Bug fixes", and anything labelled ignore-for-release is left out. The grouping only works if your team labels pull requests consistently, so decide the labels once and add a check to your pull request template.

What generated notes do not do

  • They list pull requests, not benefits. A user reading "Refactor report service" learns nothing about what changed for them.
  • They do not call out breaking changes unless someone labels or titles the pull request that way.
  • They are one document. Developers want a dated record of every change, and customers want a short explanation of what is new. One list rarely serves both.
  • They stay on the release page. A CHANGELOG.md, a public changelog page or an in-app notice still needs its own copy.

Turn the generated list into release notes people read

Automate the first draft and keep a short human pass for the rest: reword each entry from the reader's point of view, move breaking changes to the top, and drop anything internal. If you only need to turn a list of commits into a changelog entry once, a free changelog generator does it in the browser without a workflow, and there are copy-paste CHANGELOG.md templates for libraries, APIs, web apps and mobile apps.

I am building ReleaseTale, a tool that reads the commits and pull requests of a release and drafts both a plain-language version for users and a Keep a Changelog entry for developers. It has a free plan (3 changelogs, no credit card, read-only GitHub access). GitHub's generated notes and a tool like that solve different parts of the problem, so I wrote a side-by-side comparison.

How do you handle release notes on your team: generated, hand-written, or skipped? I would like to hear.