Skip to content

docs: clarify update check behavior in non-interactive environments#556

Merged
mwbrooks merged 5 commits into
mainfrom
mwbrooks-upgrade-skip-documentation
May 21, 2026
Merged

docs: clarify update check behavior in non-interactive environments#556
mwbrooks merged 5 commits into
mainfrom
mwbrooks-upgrade-skip-documentation

Conversation

@mwbrooks
Copy link
Copy Markdown
Member

@mwbrooks mwbrooks commented May 21, 2026

Changelog

Document how update checks and --skip-update behaves in non-interactive environments such as CI/CD pipelines.

Summary

This pull request documents the existing non-TTY behavior of slack upgrade and the --skip-update / SLACK_SKIP_UPDATE controls so that users running the CLI in CI/CD or scripts can find clear guidance.

  • Adds a non-interactive note to slack upgrade --help.
  • Expands the "Version update notifications" section in the authorizing guide to cover non-TTY behavior.
  • Adds a small "Disabling update checks" subsection in the CI/CD setup guide that links back.

Preview

slack upgrade --help:

image

Testing

  • Run `./bin/slack upgrade --help` and confirm the new paragraph renders without terminal wrapping.

Requirements

Document that `slack upgrade` runs the update check but skips the
auto-update prompt when no TTY is attached, and that --skip-update /
SLACK_SKIP_UPDATE fully suppress checks on other commands. Adds a
non-TTY note to the upgrade command's long description, expands the
"Version update notifications" section, and links a new "Disabling
update checks" subsection from the CI/CD guide.
@mwbrooks mwbrooks self-assigned this May 21, 2026
@mwbrooks mwbrooks added docs M-T: Documentation work only changelog Use on updates to be included in the release notes semver:patch Use on pull requests to describe the release version increment labels May 21, 2026
@mwbrooks mwbrooks added this to the Next Release milestone May 21, 2026
@mwbrooks mwbrooks marked this pull request as ready for review May 21, 2026 22:17
@mwbrooks mwbrooks requested review from a team as code owners May 21, 2026 22:17
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.63%. Comparing base (fee9c54) to head (db0ad1b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #556      +/-   ##
==========================================
- Coverage   71.64%   71.63%   -0.01%     
==========================================
  Files         226      226              
  Lines       19110    19115       +5     
==========================================
+ Hits        13691    13693       +2     
- Misses       4212     4213       +1     
- Partials     1207     1209       +2     

☔ 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.

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mwbrooks Great additions! I like when expected behavior obvious in documentation 📚


You're now ready to begin developing [Bolt](/quickstart) and [Deno Slack SDK](/tools/deno-slack-sdk/guides/getting-started) apps!

### Version update notifications {#version-updates}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

☕ 🌞 praise: Thanks for keeping with the latest!

Comment thread docs/guides/authorizing-the-slack-cli.md Outdated
Comment thread docs/guides/authorizing-the-slack-cli.md Outdated
Comment thread docs/guides/setting-up-ci-cd-with-the-slack-cli.md Outdated
@lukegalbraithrussell
Copy link
Copy Markdown
Contributor

small suggestions on words

mwbrooks and others added 3 commits May 21, 2026 15:28
Co-authored-by: Luke Russell <31357343+lukegalbraithrussell@users.noreply.github.com>
Co-authored-by: Luke Russell <31357343+lukegalbraithrussell@users.noreply.github.com>
Co-authored-by: Luke Russell <31357343+lukegalbraithrussell@users.noreply.github.com>
@mwbrooks
Copy link
Copy Markdown
Member Author

@lukegalbraithrussell @zimeg Thanks for the super fast reviews and improvements to the words! 📚 Loving the rapid flow and iterations that we can make on doc improvements now!

@mwbrooks mwbrooks enabled auto-merge (squash) May 21, 2026 22:30
@mwbrooks mwbrooks merged commit aad8f88 into main May 21, 2026
9 checks passed
@mwbrooks mwbrooks deleted the mwbrooks-upgrade-skip-documentation branch May 21, 2026 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog Use on updates to be included in the release notes docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants