shopify-app-express: document environment variable defaults#3111
Open
sergiocasao wants to merge 1 commit intoShopify:mainfrom
Open
shopify-app-express: document environment variable defaults#3111sergiocasao wants to merge 1 commit intoShopify:mainfrom
sergiocasao wants to merge 1 commit intoShopify:mainfrom
Conversation
Author
|
I have signed the CLA! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
@shopify/shopify-app-expressautomatically reads the following environment variables when they are not explicitly passed toshopifyApp():SHOPIFY_API_KEYSHOPIFY_API_SECRETHOST(split into hostScheme and hostName)SCOPESThis behavior is implemented in apiConfigWithDefaults() in the source, but is not mentioned anywhere in the README or docs.
see #3110
WHAT is this pull request doing?
Add a section to the
READMEdocumenting the supported environment variablesType of change
Checklist
pnpm changesetto create a draft changelog entry (do NOT update theCHANGELOG.mdfiles manually)