docs: updates environment variables page to be CLI-focused, not Deno-focused#498
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #498 +/- ##
==========================================
+ Coverage 71.19% 71.20% +0.01%
==========================================
Files 222 222
Lines 18684 18684
==========================================
+ Hits 13302 13304 +2
+ Misses 4204 4199 -5
- Partials 1178 1181 +3 ☔ 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 🌲
| | `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
There was a problem hiding this comment.
🤔 I'm unsure if these values are so useful in application code after the app is started:
Co-authored-by: Eden Zimbelman <zim@o526.net>
zimeg
left a comment
zimeg
left a comment
There was a problem hiding this comment.
@lukegalbraithrussell Super duper appreciate the changes in most recent edits! 📠
I'm approving again with some thoughts about how much information is surfaced but this isn't meant to be a blocker - just thoughts!
| You can store and use environment variables with your Slack app by using a collection of Slack CLI commands and features. You can even access some pre-set environment variables! | ||
|
|
||
| ## Using environment variables with a custom function {#custom-function} | ||
| :::note[You may be looking for the [_Using environment variables with the Deno Slack SDK_](/tools/deno-slack-sdk/guides/using-environment-variables) guide.] |
There was a problem hiding this comment.
This page doesn't exist
There was a problem hiding this comment.
it will once this is merged: https://github.com/slackapi/docs/pull/516
4 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