docs: updates environment variables page to be CLI-focused, not Deno-focused#498
docs: updates environment variables page to be CLI-focused, not Deno-focused#498lukegalbraithrussell wants to merge 6 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #498 +/- ##
==========================================
- Coverage 71.23% 71.20% -0.03%
==========================================
Files 222 222
Lines 18664 18664
==========================================
- Hits 13295 13290 -5
- Misses 4189 4192 +3
- Partials 1180 1182 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
zimeg
changed the title
zimeg
added
docs
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
@lukegalbraithrussell Incredible formats and fast writings. Thank you for polishing this page so much 🏆
I'm leaving a few comments of thoughts that could be useful but might be rambles:
- Noting the ".env" file created for projects
- Removing "internal" variables and related notes
- Favor keeping this page CLI and Bolt focused
Please do take these suggestions as optional! And let me know if I can share more details toward this 🌲
| There are three Slack CLI subcommands that can be used to modify environment variables: | ||
|
|
||
| ### Storing local environment variables {#local-env-vars} | ||
| ### `slack env set` |
There was a problem hiding this comment.
🐙 suggestion: Toward the end of this section it might be kind to note that these variables are saved to a .env file within the project?
🦕 ramble: Such a change has big preference to Bolt development, but I think the ROSI behavior might be better kept in adjacent pages.
There was a problem hiding this comment.
big agree but put it up top
| | `SLACK_APP_PATH` | Set when a custom start path is provided via `slack run` | Used to run from a non-root directory. | ✅ Supported | ✅ Supported | | ||
| | `SLACK_CLI_CUSTOM_FILE_PATH` | Set to the same value as `SLACK_APP_PATH` when a custom start path is provided via `slack run` | Used to run from a non-root directory. | ✅ Supported | ✅ Supported | |
There was a problem hiding this comment.
| | `SLACK_APP_PATH` | Set when a custom start path is provided via `slack run` | Used to run from a non-root directory. | ✅ Supported | ✅ Supported | | |
| | `SLACK_CLI_CUSTOM_FILE_PATH` | Set to the same value as `SLACK_APP_PATH` when a custom start path is provided via `slack run` | Used to run from a non-root directory. | ✅ Supported | ✅ Supported | |
🪝 suggestion: These might be most meaningful for "hook" developers, who might prefer to find this in adjacent pages:
🔗 https://docs.slack.dev/tools/slack-cli/reference/hooks/#start
There was a problem hiding this comment.
I think these should be kept in case they're confused why it's not here
Co-authored-by: Eden Zimbelman <zim@o526.net>
2 participants
Changelog
(Add a note with features or fixes that change the user experience for release notes)
Summary
The content originally here is being added to the Deno Slack SDK hub as "Using env variables with the deno slack sdk"
Preview
Using environment variables with the Slack CLI
Using environment variables with the Deno Slack SDK
Requirements