Breadcrumbs

Shortcut - Edit Story

Overview

Use this function to easily update different fields of an existing story in a project management system. It empowers you to modify essential details such as the story's name, workflow state, description, story type, labels, deadline, and tasks.

Variables

Name

Reference

Type

Required

Default

Options

Description

Access Token

SHORTCUT_ACCESS_TOKEN

Password

✅

-

-

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

Story ID

SHORTCUT_STORY_ID

Integer

✅

-

-

The ID of the story to be updated.

Story Name

SHORTCUT_STORY_NAME

Alphanumeric

➖

-

-

The name you wish to update the story to

Workflow State ID

SHORTCUT_WORKFLOW_STATE_ID

Integer

➖

-

-

ID of the workflow state you wish to move the story to

Description

SHORTCUT_DESCRIPTION

Alphanumeric

➖

-

-

The updated description for the story.

Story Type

SHORTCUT_STORY_TYPE

Select

➖

-

Feature: feature

Bug: bug

Chore: chore

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

Labels

SHORTCUT_LABELS

Alphanumeric

➖

-

-

Comma-separated labels to be added to the story.

Deadline

SHORTCUT_DEADLINE

Alphanumeric

➖

-

-

The new deadline for the story.

Tasks

SHORTCUT_TASKS

Alphanumeric

➖

-

-

Comma-separated tasks to be added to the story.

YAML

Below is the YAML template

YAML

source:
  template: Shortcut - Edit Story
  inputs:
    SHORTCUT_ACCESS_TOKEN:
    SHORTCUT_STORY_ID:
    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
    - 201