Skip to content

Commit 905bed9

Browse files
committed
Updated Clubhouse to Shortcut
Signed-off-by: snipe <snipe@snipe.net>
1 parent 13009c7 commit 905bed9

File tree

16 files changed

+417
-381
lines changed

16 files changed

+417
-381
lines changed

.idea/.gitignore

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/create-linked-shortcut-story.iml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/inspectionProfiles/Project_Default.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Create Linked Clubhouse Story
1+
# Create Linked Shortcut Story
22

33
This is a [GitHub Action](https://github.com/features/actions) that will
4-
automatically create a story on [Clubhouse](https://clubhouse.io/) when
4+
automatically create a story on [Shortcut](https://clubhouse.io/) when
55
a pull request is opened, unless the pull request already has a link to
6-
a Clubhouse story in the description.
6+
a Shortcut story in the description.
77

88
## Basic Usage
99

10-
[Create a Clubhouse API token](https://app.clubhouse.io/settings/account/api-tokens),
10+
[Create a Shortcut API token](https://app.clubhouse.io/settings/account/api-tokens),
1111
and store it as an encrypted secret in your GitHub repository settings.
1212
[Check the GitHub documentation for how to create an encrypted secret.](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets)
13-
Name this secret `CLUBHOUSE_TOKEN`.
13+
Name this secret `SHORTCUT_TOKEN`.
1414

1515
Create a file named `clubhouse.yml` in the `.github/workflows` directory of your repository. Put in the following content:
1616

@@ -26,28 +26,28 @@ jobs:
2626
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
2727
with:
2828
github-token: ${{ secrets.GITHUB_TOKEN }}
29-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
29+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
3030
project-name: Engineering
3131
opened-state-name: Started
3232
merged-state-name: Done
3333
closed-state-name: Abandoned
3434
```
3535
36-
The `project-name` variable should contain the name of the Clubhouse project
37-
that you want the Clubhouse story to be associated with. The
36+
The `project-name` variable should contain the name of the Shortcut project
37+
that you want the Shortcut story to be associated with. The
3838
`opened-state-name`, `merged-state-name`, and `closed-state-name` variables
39-
should contain the name of the state that you want the Clubhouse story to
39+
should contain the name of the state that you want the Shortcut story to
4040
be in when the pull request is opened, merged, and closed, respectively.
4141

4242
## Disabled for Built-In Integration
4343

44-
[Clubhouse already has an integration with GitHub.](https://help.clubhouse.io/hc/en-us/articles/207540323-Using-The-Clubhouse-GitHub-Integration)
45-
It works for the opposite use-case, assuming that the Clubhouse story exists
44+
[Shortcut already has an integration with GitHub.](https://help.clubhouse.io/hc/en-us/articles/207540323-Using-The-Shortcut-GitHub-Integration)
45+
It works for the opposite use-case, assuming that the Shortcut story exists
4646
_before_ the pull request is created.
4747

4848
This Action will specifically check for branch names that follow the naming
4949
convention for this built-in integration. Any branch name that contains
50-
`sc-####` will be ignored by this Action, on the assumption that a Clubhouse
50+
`sc-####` will be ignored by this Action, on the assumption that a Shortcut
5151
story already exists for the pull request. The `sc-####` must be separated
5252
from leading or following text with either a `/` or a `-`. So, branches
5353
named `sc-1`, `prefix/sc-23`, `prefix-sc-123`, `sc-3456/suffix`, `sc-3456-suffux`,
@@ -62,37 +62,37 @@ variable, like this:
6262
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
6363
with:
6464
github-token: ${{ secrets.GITHUB_TOKEN }}
65-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
65+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
6666
project-name: Engineering
6767
opened-state-name: Started
6868
merged-state-name: Done
6969
closed-state-name: Abandoned
7070
comment-template: >-
71-
Thanks for the pull request! [I've created a Clubhouse story
71+
Thanks for the pull request! [I've created a Shortcut story
7272
for you.]({{{ story.app_url }}})
7373
```
7474

7575
This comment template is processed using the [Mustache](https://mustache.github.io/)
76-
templating system. It receives [the Story object returned from the Clubhouse API](https://clubhouse.io/api/rest/v3/#Story). Note that you may want to use the
76+
templating system. It receives [the Story object returned from the Shortcut API](https://clubhouse.io/api/rest/v3/#Story). Note that you may want to use the
7777
triple mustache syntax to disable HTML escaping.
7878

7979
GitHub will automatically process the comment text as [Markdown](https://guides.github.com/features/mastering-markdown/),
8080
so you can use features like links and images if you make your comment
8181
template output valid Markdown, as shown above.
8282

8383
If you don't provide a comment template, this action will use this comment template
84-
by default: `Clubhouse story: {{{ story.app_url }}}`
84+
by default: `Shortcut story: {{{ story.app_url }}}`
8585

86-
## Customizing the Clubhouse Story Title and Body
86+
## Customizing the Shortcut Story Title and Body
8787

88-
You can customize the Clubhouse **title** and **description** when creating stories using the `story-title-template` and `story-description-template`
88+
You can customize the Shortcut **title** and **description** when creating stories using the `story-title-template` and `story-description-template`
8989
variables, like this:
9090

9191
```yaml
9292
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
9393
with:
9494
github-token: ${{ secrets.GITHUB_TOKEN }}
95-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
95+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
9696
project-name: Engineering
9797
opened-state-name: Started
9898
merged-state-name: Done
@@ -108,29 +108,29 @@ variables, like this:
108108
```
109109

110110
The story title and body templates are processed using the [Mustache](https://mustache.github.io/)
111-
templating system. It receives [the Payload object returned from the GitHub API](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#pull_request). Note that you may want to use the triple mustache syntax to disable HTML escaping. Also Clubhouse supports full Markdown formatting, emojis, and @ mentions. Feel free to use them to your heart's desire. :heart_eyes_cat:
111+
templating system. It receives [the Payload object returned from the GitHub API](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#pull_request). Note that you may want to use the triple mustache syntax to disable HTML escaping. Also Shortcut supports full Markdown formatting, emojis, and @ mentions. Feel free to use them to your heart's desire. :heart_eyes_cat:
112112

113113
If you don't provide a title or body template, this action will simply use the Pull Request Title (`{{{ payload.pull_request.title }}}`) and Pull Request Body (`{{{ payload.pull_request.body }}}`) by default.
114114

115115
## User Map
116116

117-
This Action does its best to automatically assign the created Clubhouse story
117+
This Action does its best to automatically assign the created Shortcut story
118118
to the person who created the GitHub pull request. However, due to limitations
119-
of the GitHub API and the Clubhouse API, this will only work automatically
120-
when the GitHub user and the Clubhouse user share the same _primary_ email
119+
of the GitHub API and the Shortcut API, this will only work automatically
120+
when the GitHub user and the Shortcut user share the same _primary_ email
121121
address. Even though both services allow you to add multiple secondary email
122122
addresses, only the _primary_ email address is exposed in the API.
123123

124124
As a workaround, you can maintain a user map, which teaches this Action how to
125-
map GitHub users to Clubhouse users. The user map should be passed in the
125+
map GitHub users to Shortcut users. The user map should be passed in the
126126
`with` section, and due to the limitations of GitHub Actions, must be a JSON
127127
formatted string. Here's an example:
128128

129129
```yaml
130130
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
131131
with:
132132
github-token: ${{ secrets.GITHUB_TOKEN }}
133-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
133+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
134134
project-name: Engineering
135135
user-map: |
136136
{
@@ -140,13 +140,13 @@ formatted string. Here's an example:
140140
```
141141

142142
The keys of this JSON object must be GitHub usernames, while the values
143-
must be Clubhouse UUIDs that identify members. Unfortunately, these UUIDs
144-
are not exposed on the Clubhouse website; the best way to look them up is to
145-
[go to the User Directory for your Clubhouse workspace](https://app.clubhouse.io/settings/users),
143+
must be Shortcut UUIDs that identify members. Unfortunately, these UUIDs
144+
are not exposed on the Shortcut website; the best way to look them up is to
145+
[go to the User Directory for your Shortcut workspace](https://app.clubhouse.io/settings/users),
146146
open the Developer Tools in your browser, find the API request for
147147
`https://app.clubhouse.io/backend/api/private/members`,
148148
and examine the API response to find the `id` for each user.
149-
Note that Clubhouse makes a distinction between a `User` and a `Member`:
149+
Note that Shortcut makes a distinction between a `User` and a `Member`:
150150
you need to look up the UUID for the `Member` object.
151151

152152
## Ignored Users
@@ -158,7 +158,7 @@ Multiple users should be separated by commas.
158158
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
159159
with:
160160
github-token: ${{ secrets.GITHUB_TOKEN }}
161-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
161+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
162162
project-name: Engineering
163163
ignored-users: hubot, dependabot
164164
```
@@ -172,23 +172,23 @@ Multiple users should be separated by commas.
172172
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
173173
with:
174174
github-token: ${{ secrets.GITHUB_TOKEN }}
175-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
175+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
176176
project-name: Engineering
177177
only-users: dependabot
178178
```
179179

180180
## Iteration Support
181181

182-
Clubhouse supports the concept of [iterations](https://help.clubhouse.io/hc/en-us/articles/360028953452-Iterations-Overview)
182+
Shortcut supports the concept of [iterations](https://help.clubhouse.io/hc/en-us/articles/360028953452-Iterations-Overview)
183183
-- time-boxed periods of development for stories. You can configure this Action
184-
to automatically assign the Clubhouse stories it creates to Clubhouse iterations,
185-
using GitHub labels and Clubhouse groups to identify the correct iteration to use.
184+
to automatically assign the Shortcut stories it creates to Shortcut iterations,
185+
using GitHub labels and Shortcut groups to identify the correct iteration to use.
186186

187187
In order to use this feature, this Action makes a few assumptions about
188-
the way you use Clubhouse and GitHub:
188+
the way you use Shortcut and GitHub:
189189

190-
- We assume that each team has an associated [Clubhouse group](https://help.clubhouse.io/hc/en-us/articles/360039328751-Groups-Group-Management),
191-
and that Clubhouse iterations are associated with this group.
190+
- We assume that each team has an associated [Shortcut group](https://help.clubhouse.io/hc/en-us/articles/360039328751-Groups-Group-Management),
191+
and that Shortcut iterations are associated with this group.
192192
- We assume that the correct iteration to use is the _most recent_
193193
in-progress iteration for the group, as determined by the "last updated" time.
194194
(However, you may exclude specific iterations by name.)
@@ -215,13 +215,13 @@ on:
215215
```
216216

217217
Next, provide a JSON-formatted string to the `label-iteration-group-map` input.
218-
This is used to map GitHub labels to Clubhouse groups. Here is an example:
218+
This is used to map GitHub labels to Shortcut groups. Here is an example:
219219

220220
```yaml
221221
- uses: singingwolfboy/create-linked-clubhouse-story@v1.8
222222
with:
223223
github-token: ${{ secrets.GITHUB_TOKEN }}
224-
clubhouse-token: ${{ secrets.CLUBHOUSE_TOKEN }}
224+
clubhouse-token: ${{ secrets.SHORTCUT_TOKEN }}
225225
project-name: Engineering
226226
label-iteration-group-map: |
227227
{
@@ -236,6 +236,6 @@ This is used to map GitHub labels to Clubhouse groups. Here is an example:
236236
```
237237

238238
In this example, "Team Octocat" and "Unicorns" are labels on GitHub.
239-
The "groupId" refers to the ID of the Clubhouse group that are associated
239+
The "groupId" refers to the ID of the Shortcut group that are associated
240240
with these respective teams. The "excludeName" key is optional;
241241
if provided, it is used to exclude specific iterations from consideration.

0 commit comments

Comments
 (0)