Skip to content

Commit 30656b5

Browse files
authored
fix: redirect missing hook remediation links to the current deno starter template (#166)
1 parent 40e6863 commit 30656b5

File tree

3 files changed

+28
-19
lines changed

3 files changed

+28
-19
lines changed

docs/guides/installing-the-slack-cli-for-mac-and-linux.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@ slug: /slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
55

66
# Installing the Slack CLI for Mac & Linux
77

8-
98
The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools.
109

1110
**If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
1211

1312
⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**.
1413

15-
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]
14+
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]
1615

1716
If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
1817

@@ -32,6 +31,7 @@ the runtime environment for workflow apps. If you have VSCode installed,
3231
the [VSCode Deno
3332
extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno)
3433
will be installed.
34+
3535
<details>
3636
<summary>Optional: Use an alias for the Slack CLI binary</summary>
3737

@@ -61,14 +61,17 @@ If you don't rename the slack binary to a different name, the installation scrip
6161
There are two optional flags available to customize the installation.
6262

6363
1. Specify a version you'd like to install using the version flag, `-v`. The absence of this flag will ensure the latest Slack CLI version is installed.
64+
6465
```
6566
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -v 2.1.0
6667
```
6768

6869
2. Skip the Deno installation by using the `-d` flag, like this:
70+
6971
```
7072
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -d
7173
```
74+
7275
</details>
7376

7477
<details>
@@ -140,12 +143,12 @@ $ slack doctor
140143
If you have upgraded your CLI version but your `deno-slack-hooks` version is less than `v1.3.0`, when running `slack doctor`, you will see the following near the end of the output:
141144

142145
```
143-
✔ Configurations (your project's CLI settings)
146+
✔ Configurations (your project's CLI settings)
144147
Project ID: 1a2b3c4d-ef5g-67hi-8j9k1l2m3n4o
145148
146149
✘ Runtime (foundations for the application)
147150
Error: The `doctor` hook was not found (sdk_hook_not_found)
148-
Suggestion: Ensure this hook is implemented in your `slack.json`
151+
Suggestion: Debug responses from the Slack hooks file (.slack/hooks.json)
149152
150153
✔ Dependencies (requisites for development)
151154
deno_slack_hooks: 1.2.3 → 1.3.0 (supported version)
@@ -156,10 +159,13 @@ In addition, if you attempt to run the `slack run` command without this dependen
156159
```
157160
🚫 The `start` script was not found (sdk_hook_not_found)
158161
159-
💡 Suggestion
160-
Hook scripts are defined in the Slack configuration file ('slack.json').
161-
Every app requires a 'slack.json' file and you can find a working example at:
162-
https://github.com/slack-samples/deno-starter-template/blob/main/slack.json
162+
💡 Suggestion
163+
Hook scripts are defined in one of these Slack hooks files:
164+
- slack.json
165+
- .slack/hooks.json
166+
167+
Every app requires a Slack hooks file and you can find a working example at:
168+
https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json
163169
164170
```
165171

docs/guides/installing-the-slack-cli-for-windows.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@ slug: /slack-cli/guides/installing-the-slack-cli-for-windows
55

66
# Installing the Slack CLI for Windows
77

8-
98
The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools.
109

1110
**If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
1211

1312
⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**.
1413

15-
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]
14+
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]
1615

1716
If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
1817

@@ -128,6 +127,7 @@ If you have another CLI tool in your path called `slack`, we recommend renaming
128127
:::
129128

130129
**6\. Verify that** `slack` **is installed and in your path:**
130+
131131
```
132132
$ slack version
133133
Using slack v3.5.1
@@ -136,6 +136,7 @@ Using slack v3.5.1
136136
**7\. Verify that all dependencies have been installed.**
137137

138138
Run the following command:
139+
139140
```
140141
$ slack doctor
141142
```
@@ -150,7 +151,7 @@ If you have upgraded your CLI version but your `deno-slack-hooks` version is les
150151
151152
✘ Runtime (foundations for the application)
152153
Error: The `doctor` hook was not found (sdk_hook_not_found)
153-
Suggestion: Ensure this hook is implemented in your `slack.json`
154+
Suggestion: Debug responses from the Slack hooks file (.slack/hooks.json)
154155
155156
✔ Dependencies (requisites for development)
156157
deno_slack_hooks: 1.2.3 → 1.3.0 (supported version)
@@ -159,18 +160,20 @@ If you have upgraded your CLI version but your `deno-slack-hooks` version is les
159160
In addition, if you attempt to run the `slack run` command without this dependency installed, you will see a similar error in your console:
160161

161162
```
162-
🚫 The `start` script was not found (sdk_hook_not_found)
163+
🚫 The `start` script was not found (sdk_hook_not_found)
164+
165+
💡 Suggestion
166+
Hook scripts are defined in one of these Slack hooks files:
167+
- slack.json
168+
- .slack/hooks.json
163169
164-
💡 Suggestion
165-
Hook scripts are defined in the Slack configuration file ('slack.json').
166-
Every app requires a 'slack.json' file and you can find a working example at:
167-
https://github.com/slack-samples/deno-starter-template/blob/main/slack.json
170+
Every app requires a Slack hooks file and you can find a working example at:
171+
https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json
168172
```
169173

170174
Ensure that `deno-slack-hooks` is installed at the project level and that the version is not less than `v1.3.0`.
171175

172-
**8\. [Install the VSCode extension for
173-
Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
176+
**8\. [Install the VSCode extension for Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
174177

175178
</TabItem>
176179
</Tabs>

internal/slackerror/errors.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1332,7 +1332,7 @@ Otherwise start your app for local development with: %s`,
13321332
"- " + filepath.Join(".slack", "hooks.json"),
13331333
"",
13341334
"Every app requires a Slack hooks file and you can find an example at:",
1335-
style.Highlight("https://github.com/slack-samples/deno-starter-template/blob/main/slack.json"),
1335+
style.Highlight("https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json"),
13361336
"",
13371337
"You can create a hooks file manually or with the " + style.Commandf("init", false) + " command.",
13381338
"",

0 commit comments

Comments
 (0)