README.md

Clubhouse Release

This action creates a formatted release in github from formatted commit messages annotated with Shortcut story data. Shortcut PR can automatically format your PR titles (and commit messages, once merged) for use with this action.

Inputs

ghToken

Required Github token

createChangelog

Default true

Would you like to generate a changelog for this release?

chStoryUrl

Shortcut story URL (ie. https://app.shortcut.com/org/story)

tag

The git tag for the current release.

previousTag

The git tag of the most recent prior release.

prerelease

Would you like the release be created in the "prereleased" state?

Default false

Development

Run yarn tdd to watch Jest tests as you make your changes.

Run yarn lint:watch to watch for ESLint errors/warnings.

Example usage

Prerelease

on:
  push:
    tags:
      - '*'
...

uses: actions/release@v1
with:
  ghToken: ${{ secrets.GITHUB_TOKEN }}
  chStoryUrl: 'https://app.shortcut.com/org/story'
  tag: "v1.0.0"
  ## prerelease: false # default is true
  previousTag: "v0.0.9" # is required if you're generating a changelog

Release

on: repository_dispatch
...

uses: actions/release@v1
with:
  ghToken: ${{ secrets.GITHUB_TOKEN }}
  tag: ${{ github.event.release.tag_name }}
  prerelease: false
  createChangelog: false