Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

oauth(docs): replace hardcoded state secrets with process env variables #2039

Merged
merged 3 commits into from
Sep 24, 2024

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Sep 24, 2024

Summary

This PR replaces examples of hardcoded state secrets with an environment variable to match slackapi/bolt-js#2220

Requirements

@zimeg zimeg added docs M-T: Documentation work only pkg:oauth applies to `@slack/oauth-helper` labels Sep 24, 2024
@zimeg zimeg added this to the oauth@3.x milestone Sep 24, 2024
@zimeg zimeg requested a review from filmaj September 24, 2024 18:42
@zimeg zimeg self-assigned this Sep 24, 2024
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.51%. Comparing base (02f9b87) to head (7743f21).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2039   +/-   ##
=======================================
  Coverage   92.51%   92.51%           
=======================================
  Files          37       37           
  Lines        9981     9981           
  Branches      633      631    -2     
=======================================
  Hits         9234     9234           
  Misses        747      747           
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 96.00% <ø> (ø)
oauth 81.52% <ø> (ø)
socket-mode 59.08% <ø> (ø)
web-api 97.29% <ø> (ø)
webhook 97.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

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

LGTM but can you also add the env var to the list of env vars needed in the relevant samples' README.md?

@zimeg
Copy link
Member Author

zimeg commented Sep 24, 2024

@filmaj A good call as always, thanks for catching that and the fast review 🙏

@zimeg zimeg merged commit 0861218 into slackapi:main Sep 24, 2024
32 checks passed
@zimeg zimeg deleted the zimeg-oauth-state-secret-env branch September 24, 2024 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only pkg:oauth applies to `@slack/oauth-helper`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants