Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

Shortcut PR

v1

Shortcut PR

play

Shortcut PR

Update Github PR with Shortcut information

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Shortcut PR

uses: farmersdog/clubhouse-pr@v1

Learn more about this action in farmersdog/clubhouse-pr

Choose a version

ClubHouse Pull Request Github Action

code style: prettier Test

Automatically update your Github Pull Request with a Clubhouse title in the format: (feat) Some Feature [ch123]. And adds the Clubhouse story's URL to the beginning of the body of your PR.

Inputs

ghToken

Required GITHUB_TOKEN

chToken

Required Clubhouse API Token

Outputs

prTitle

The title of the pull request

Development

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

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

Note: Always run yarn build before pushing any changes.

Example usage

Note: This is for use when opening a pull request.

on:
  pull_request:
    types: [opened]
uses: actions/clubhouse-pr@v1
with:
  ghToken: ${{ secrets.GITHUB_TOKEN }}
  chToken: ${{ secrets.CLUBHOUSE_API_TOKEN }}