action.yml

name: Create Linked Clubhouse Story
author: David Baumgold <david@davidbaumgold.com>
description: >-
  When a pull request is opened, create a linked story on Clubhouse
  if the description does not already link to one.
inputs:
  github-token:
    description: API token for GitHub. Can be passed in using {{ secrets.GITHUB_TOKEN }}
    required: true
  clubhouse-token:
    description: API token for Clubhouse.io
    required: true
  project-name:
    description: The name of the Clubhouse.io project to create stories in
    required: true
  opened-state-name:
    description: The name of the workflow state for Clubhouse stories when a pull request is created.
  closed-state-name:
    description: The name of the workflow state for Clubhouse stories when a pull request is closed.
    required: true
  merged-state-name:
    description: The name of the workflow state for Clubhouse stories when a pull request is merged.
    required: true
  comment-template:
    description: >-
      A Mustache template for the comment posted on a pull request, after the
      Clubhouse story is successfully created. The template is populated
      with a `story` variable.
    default: "Clubhouse story: {{{ story.app_url }}}"
  clubhouse-story-title-template:
    description: >-
      A Mustache template used for the story title in Clubhouse. The template is populated with a
      `payload` variable.
    default: "{{{ payload.pull_request.title }}}"
  clubhouse-story-body-template:
    description: >-
      A Mustache template used for the story body in Clubhouse. The template is populated with a
      `payload` variable.
    default: "{{{ payload.pull_request.body }}}"
  only-users:
    description: Comma-separated list of specific GitHub users to create Clubhouse stories for. 
  ignored-users:
    description: Comma-separated list of GitHub users to ignore. Often used for bots.
  user-map:
    description: Map GitHub usernames to Clubhouse UUIDs
outputs:
  story-id:
    description: The ID of the associated story on Clubhouse
runs:
  using: node12
  main: dist/index.js
branding:
  icon: git-pull-request
  color: blue