6min

Shortcut

Work in progress!

The Shortcut integration is a recent addition to Echoes and this documentation page is still considered work in progress.

Purpose

Echoes can connect to your Shortcut instance and help you tag Shortcut Stories and Epics with the intended outcomes and initiatives they contribute to. This allows you to express the purpose of work during the planning process in Shortcut and have related code contributions inherit these annotations, therefore reducing the labelling effort for engineers.

Installation

Shortcut integration is done through the integrations settings. The installation will guide you into generating a Shortcut API token and installing the webhooks.

Shortcut instalation flow
Shortcut instalation flow

How to use

Echoes creates labels on the Shortcut workspaces on which it is enabled: one for each configured outcome and initiative (they will all be prefixed with Echoes: ):

You can link GitHub pull requests or GitLab merge requests to Shortcut Stories through their branch name, the issue ID in their title, or the issue ID in their description (as described in Shortcut documentation). Echoes detects this link and directly applies the labels it finds on both the linked Story and its parent Epic (if any).

Labeling behavior details

  • Labels are only applied when a pull request is opened, edited, or reopened. Changing the intent on a Shortcut Story or Epic will not change the labels on a previously opened pull request.
  • The automation only adds more labels and never removes previously existing labels from the pull request.

๏ปฟ

๏ปฟ

๏ปฟ

๏ปฟ

Updated 20 Jan 2022
Did this page help you?
Yes
No