feat(deploy): improve error message when no deploy script found by srtaalej · Pull Request #330 · slackapi/slack-cli

srtaalej · 2026-02-05T16:55:09Z

Summary

This PR updates the deploy command to show a helpful message suggesting slack run for local development when no deploy hook is configured.

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2026-02-05T16:58:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.67%. Comparing base (9250b37) to head (e2e46ec).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #330      +/-   ##
==========================================
- Coverage   64.68%   64.67%   -0.01%     
==========================================
  Files         212      212              
  Lines       17778    17775       -3     
==========================================
- Hits        11499    11496       -3     
  Misses       5204     5204              
  Partials     1075     1075

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

zimeg

@srtaalej Super nice improvements for a better experience in getting started ⭐

I'm requesting a few changes before this merges since we might not have a great page to reference at the moment, and I also left a few comments on formatting and tests that might be nice to polish too 🧪 ✨

zimeg · 2026-02-05T19:55:28Z

cmd/platform/deploy_test.go

+	assert.Contains(t, slackErr.Remediation, "run")
+	assert.Contains(t, slackErr.Remediation, "local development server")
+	assert.Contains(t, slackErr.Remediation, "https://docs.slack.dev/deployment")
+}


🧪 suggestion: Can we include this as a case in the table tests below?

👾 suggestion: We want to avoid writing tests outside of our "table" test structures surrounding. I do think we can extend this case as well, for a smaller change:

slack-cli/cmd/platform/deploy_test.go

Lines 144 to 147 in 40b65e3

"fails if no deploy hook is provided": {

manifestSource: config.ManifestSourceLocal,

expectedError: slackerror.New(slackerror.ErrSDKHookNotFound),

},

Looks possible!

cmd/platform/deploy.go

zimeg · 2026-02-05T20:02:02Z

cmd/platform/deploy.go

+				"To start a local development server, use:",
+				fmt.Sprintf("  %s", style.Commandf("run", false)),


👁️‍🗨️ suggestion(non-blocking): Keeping the command inline might be nice for consistent formatting overall?

To start a local development server, use: slack run For deployment options, see: https://docs.slack.dev/tools/slack-cli/reference/hooks/#deploy

Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

mwbrooks

👏🏻 Looks amazing @srtaalej!

✏️ I left a small suggestion to change the formatting. Once the tests are looking good, we can toss a ✅ on this one!

mwbrooks · 2026-02-06T02:41:31Z

cmd/platform/deploy.go

+				"To start a local development server, use:", fmt.Sprintf("  %s", style.Commandf("run", false)),
 				"",
-				fmt.Sprintf("Example `%s` `deploy` hook:", config.GetProjectHooksJSONFilePath()),
-				"{",
-				`  "hooks": {`,
-				`    "deploy": "./deploy.sh"`,
-				"  }",
-				"}",
+				"For deployment options, see: https://docs.slack.dev/tools/slack-cli/reference/hooks/#deploy",


suggestion: I have 2 small formatting suggestions:

Flip the lines around so the last line is how to run a local server. I think this allows the lack run to catch the eye better and is more likely to be noticed.

Put the URL on a newline so that it has more character width and is less likely to wrap on 80 character terminals (default width).

Suggested change

"To start a local development server, use:", fmt.Sprintf(" %s", style.Commandf("run", false)),

"",

fmt.Sprintf("Example `%s` `deploy` hook:", config.GetProjectHooksJSONFilePath()),

"{",

` "hooks": {`,

` "deploy": "./deploy.sh"`,

" }",

"}",

"For deployment options, see: https://docs.slack.dev/tools/slack-cli/reference/hooks/#deploy",

"For deployment options, see:",

" https://docs.slack.dev/tools/slack-cli/reference/hooks/#deploy",

"",

"To start a local development server, use:",

fmt.Sprintf(" %s", style.Commandf("run", false)),

github is not letting me commit this change so i added it manually 🫡

mwbrooks · 2026-02-06T02:43:31Z

cmd/platform/deploy_test.go

+	assert.Contains(t, slackErr.Remediation, "run")
+	assert.Contains(t, slackErr.Remediation, "local development server")
+	assert.Contains(t, slackErr.Remediation, "https://docs.slack.dev/deployment")
+}


Looks possible!

zimeg

👁️‍🗨️ Left a comment on test pending from earlier conversation!

zimeg · 2026-02-05T21:36:14Z

cmd/platform/deploy_test.go

+	assert.Contains(t, slackErr.Remediation, "run")
+	assert.Contains(t, slackErr.Remediation, "local development server")
+	assert.Contains(t, slackErr.Remediation, "https://docs.slack.dev/deployment")
+}


👾 suggestion: We want to avoid writing tests outside of our "table" test structures surrounding. I do think we can extend this case as well, for a smaller change:

slack-cli/cmd/platform/deploy_test.go

Lines 144 to 147 in 40b65e3

"fails if no deploy hook is provided": {

manifestSource: config.ManifestSourceLocal,

expectedError: slackerror.New(slackerror.ErrSDKHookNotFound),

},

feat(deploy): improve error message when no deploy script found

71fdf86

srtaalej self-assigned this Feb 5, 2026

srtaalej requested a review from a team as a code owner February 5, 2026 16:55

srtaalej added enhancement M-T: A feature request for new functionality semver:minor Use on pull requests to describe the release version increment labels Feb 5, 2026

srtaalej requested review from mwbrooks and zimeg February 5, 2026 18:58

zimeg requested changes Feb 5, 2026

View reviewed changes

srtaalej and others added 4 commits February 5, 2026 15:15

Update cmd/platform/deploy.go

d3b7256

Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

Merge branch 'main' into ale-deploy-cmd-teach-run

d1165b7

format deploy.go

1f7430a

test: update test to expect correct docs url

40b65e3

srtaalej requested a review from zimeg February 5, 2026 21:33

Merge branch 'main' into ale-deploy-cmd-teach-run

d4842f4

mwbrooks approved these changes Feb 6, 2026

View reviewed changes

srtaalej added 2 commits February 6, 2026 12:14

adjust print format to highlight cmd

9084770

tests: add errormissingdeployhook test to table test

e2e46ec

zimeg reviewed Feb 6, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(deploy): improve error message when no deploy script found#330

feat(deploy): improve error message when no deploy script found#330
srtaalej wants to merge 8 commits intomainfrom
ale-deploy-cmd-teach-run

srtaalej commented Feb 5, 2026

Uh oh!

codecov bot commented Feb 5, 2026 •

edited

Loading

Uh oh!

zimeg left a comment

Uh oh!

zimeg Feb 5, 2026

Uh oh!

zimeg Feb 5, 2026

Uh oh!

mwbrooks Feb 6, 2026

Uh oh!

Uh oh!

zimeg Feb 5, 2026

Uh oh!

mwbrooks left a comment

Uh oh!

mwbrooks Feb 6, 2026

Uh oh!

srtaalej Feb 6, 2026

Uh oh!

mwbrooks Feb 6, 2026

Uh oh!

zimeg left a comment

Uh oh!

zimeg Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	"fails if no deploy hook is provided": {
	manifestSource: config.ManifestSourceLocal,
	expectedError: slackerror.New(slackerror.ErrSDKHookNotFound),
	},

		"To start a local development server, use:",
		fmt.Sprintf(" %s", style.Commandf("run", false)),

Conversation

srtaalej commented Feb 5, 2026

Summary

Requirements

Uh oh!

codecov bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Feb 5, 2026 •

edited

Loading