shortcut-releasenotes-github-action

Scienta's take on release notes using Shortcut:

• Decide which version is the predecessor of this release.
• Fetch stories from commit messages, pull requests and the comments on those PRs.
• Add a version label to all completed stories.
• Render all stories as release notes based on a given ejs template.

Usage with Github Actions

Use this action on a release trigger. In the body of a release you can add a release notes tag. This tag will be substituted with the generated release notes markdown.

Example:

While creating a release in Github, add a tag to the release message body. Use the name of the predecessor of this release. All issues between the current release and it's given predecessor will added to the release notes.

[rn > 7.2.0]

Will result in: 👇👇👇

Release Notes 7.2.1

Release notes are created between releases 7.2.0 and 7.2.1.

• 👉 View stories in Shortcut
• 👉 View Github diff

🚀 Features

• Create new login page [236]
• Add new editor [237]

🐛 Bugs

• Fix broken redirect [125]
• undefined is definitely not a function [308]

---

👆👆👆

Development

Run Docker Stack

Create a .env file based on the template. The payload of a github action can be retrieved by using this action in your workflow

Run using docker-compose:

docker-compose  up -d --force-recreate --remove-orphans

install dependencies

docker exec -ti clubhouse-releasenotes-github-action yarn

Run

Github Actions has the custom to use hyphens for inputs, even though inputs are transported to node using the environment. At first I had the simulate-ga added as an yarn script, but both yarn and npm remove "invalid" values from the environment.

Use this bash script instead:

docker exec -ti clubhouse-releasenotes-github-action ./simulate-ga.sh

Templating

releasenotes-template

The following variables are available:

Variable	Description	Type
head	Tag name of the release	string
base	Tag name of the version to base the release on	string
stories	Shortcut stories	Story[]
labelVersionFilter	Filter a Label[] to return only other version labels. It's own version is omitted.	(labels: Label[]) => Label[]
createStoryTypeFilter	Creates a callback which can be used in stories.filter to filter on a story type.	(storyType: string) => ((stories: Story[]) => Story[])
repositoryOwner	Github repository owner	string
repository	Github repository	string

no-stories-template

The following variables are available:

Variable	Description	Type
head	Tag name of the release	string
base	Tag name of the version to base the release on	string
repositoryOwner	Github repository owner	string
repository	Github repository	string

Github Action

Inputs

Input	Description
github-token	Github Personal Access Token
clubhouse-token	Shortcut API token
repository-owner	Repository owner where releases are made from
repository-name	Repository where releases are made from
releasenotes-template	ejs-driven markdown template to render the release notes
no-stories-template	ejs-driven markdown template to render if there are no completed stories found

action example

name: Generate release notes
on:
  release:
    types: [ created, edited ]
jobs:
  generate-releasenotes:
    name: Generate release notes
    runs-on: ubuntu-latest
    steps:
      - $ref: ./partials/checkout.yml

      - name: Read release notes markdown template
        id: releasenotes-template
        uses: juliangruber/read-file-action@v1
        with:
          path: ./.github/release-notes/releas-notes.template.md
      - name: Read release notes no stories markdown template
        id: no-stories-template
        uses: juliangruber/read-file-action@v1
        with:
          path: .github/release-notes/no-stories-found.template.md

      - name: Generate release notes
        uses: ScientaNL/clubhouse-releasenotes-github-action@main
        with:
          github-token: "${{ secrets.GITHUB_TOKEN }}"
          clubhouse-token: "${{ secrets.CLUBHOUSE_API }}"
          repository-owner: "owner"
          repository-name: "repo"
          releasenotes-template: "${{ steps.releasenotes-template.outputs.content }}"
          no-stories-template: "${{ steps.no-stories-template.outputs.content }}"