You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-40Lines changed: 40 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Create Linked Clubhouse Story
1
+
# Create Linked Shortcut Story
2
2
3
3
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
5
5
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.
7
7
8
8
## Basic Usage
9
9
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),
11
11
and store it as an encrypted secret in your GitHub repository settings.
12
12
[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`.
14
14
15
15
Create a file named `clubhouse.yml` in the `.github/workflows` directory of your repository. Put in the following content:
Thanks for the pull request! [I've created a Clubhouse story
71
+
Thanks for the pull request! [I've created a Shortcut story
72
72
for you.]({{{ story.app_url }}})
73
73
```
74
74
75
75
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
77
77
triple mustache syntax to disable HTML escaping.
78
78
79
79
GitHub will automatically process the comment text as [Markdown](https://guides.github.com/features/mastering-markdown/),
80
80
so you can use features like links and images if you make your comment
81
81
template output valid Markdown, as shown above.
82
82
83
83
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 }}}`
85
85
86
-
## Customizing the Clubhouse Story Title and Body
86
+
## Customizing the Shortcut Story Title and Body
87
87
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`
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:
112
112
113
113
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.
114
114
115
115
## User Map
116
116
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
118
118
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
121
121
address. Even though both services allow you to add multiple secondary email
122
122
addresses, only the _primary_ email address is exposed in the API.
123
123
124
124
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
126
126
`with`section, and due to the limitations of GitHub Actions, must be a JSON
0 commit comments