Skip to content

shopify-app-express: document environment variable defaults#3111

Open
sergiocasao wants to merge 1 commit intoShopify:mainfrom
sergiocasao:main
Open

shopify-app-express: document environment variable defaults#3111
sergiocasao wants to merge 1 commit intoShopify:mainfrom
sergiocasao:main

Conversation

@sergiocasao
Copy link

@sergiocasao sergiocasao commented Mar 20, 2026

WHY are these changes introduced?

@shopify/shopify-app-express automatically reads the following environment variables when they are not explicitly passed to shopifyApp():

  • SHOPIFY_API_KEY
  • SHOPIFY_API_SECRET
  • HOST (split into hostScheme and hostName)
  • SCOPES

This 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 README documenting the supported environment variables

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
  • Minor: New feature (non-breaking change which adds functionality)
  • Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have used pnpm changeset to create a draft changelog entry (do NOT update the CHANGELOG.md files manually)
  • I have added/updated tests for this change
  • I have documented new APIs/updated the documentation for modified APIs (for public APIs)

@sergiocasao
Copy link
Author

I have signed the CLA!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant