Breadcrumbs

Shortcut - Create Story

Overview

Use this blueprint to create a new story in Shortcut. The script requires an access token, story name, workflow state ID, and story type to create the new story. Optional arguments like description, labels, deadline, and tasks can also be provided to add additional details to the story.

Variables

Name

Reference

Type

Required

Default

Options

Description

Access Token

SHORTCUT_ACCESS_TOKEN

Password

-

-

In order to generate a Workspace specific API token, navigate to Settings > Your Account > API Tokens.

Story Name

SHORTCUT_STORY_NAME

Alphanumeric

-

-

The name/title of the new story.

Workflow State ID

SHORTCUT_WORKFLOW_STATE_ID

Integer

-

-

The ID of the workflow state for the new story.

Description

SHORTCUT_DESCRIPTION

Alphanumeric

-

-

The description of the new story.

Story Type

SHORTCUT_STORY_TYPE

Select

-

Feature: feature

Bug: bug

Chore: chore

The type of the new story (feature, bug, or chore).

Labels

SHORTCUT_LABELS

Alphanumeric

-

-

Comma-separated labels to be added to the new story.

Deadline

SHORTCUT_DEADLINE

Alphanumeric

-

-

The deadline for the new story.

Tasks

SHORTCUT_TASKS

Alphanumeric

-

-

Comma-separated tasks to be added to the new story.

YAML

Below is the YAML template

YAML

source:
  template: Shortcut - Create Story
  inputs:
    SHORTCUT_ACCESS_TOKEN:
    SHORTCUT_STORY_NAME:
    SHORTCUT_WORKFLOW_STATE_ID:
    SHORTCUT_DESCRIPTION:
    SHORTCUT_STORY_TYPE:
    SHORTCUT_LABELS:
    SHORTCUT_DEADLINE:
    SHORTCUT_TASKS:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 202
    - 203