Release Defaults

Ever needed to release something without having the time to write release notes? Ever found yourself reading the commit log to be able to tell someone what changes are in the release?

Release Defaults drafts release-notes for releases that don't have a body.

Goals (and non-goals)

Pull-Request Overview
Direct Commit Collapsed Overview
Less annoying than commit-log
Show previous release notes for the same major/minor version
Organize by PR labels
Allow some customization

Non Goals

Customer Ready or picture perfect
Project specific additions that can't be solved with a configuration

How Release Defaults works

Every time it finds an empty release body, it activates (created, edited, etc)
It fetches a list of releases that are older (according to semver)
It compares the current release to the last one
It finds all the pull-requests for the difference and grabs the details.
A new release note body is created
- Pull-Requests
- Collapsed list of commits that don't belong to a PR
- Lists release-notes for previous releases of the same major+minor version. E.g. 1.0.1 will list 1.0.0 as a previous release, but not 0.9.1.

Before

Fix: Added some stuff to some lines

After

A very important feature PR (#3)
Another important feature PR (#4)

Direct Commits

Andri: sort of works now
Andri: Merge branch 'master' of github.com:andrioid/draft-on-release-tag

Previous releases

v0.0.5: count: 13

First PR test (#2)

Setup

# Install dependencies
npm install

# Run the bot
npm start

Docker

# 1. Build container
docker build -t draft-on-release-tag .

# 2. Start container
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> draft-on-release-tag

Github Actions

Add to a Github workflow file (e.g. .github/workflows/example.yml)

name: Release Defaults Bot
on:
  release:
    types:
      - created
      - edited

jobs:
  release-notes:
    runs-on: ubuntu-latest
    steps:
      - uses: andrioid/release-defaults-bot@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Contributing

If you have suggestions for how draft-on-release-tag could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

Credits

Shields.io for their wonderful (non-tracking) image badges that we use for labels

andrioid/release-defaults-bot