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

Document DENO_ Prefix Restriction for Environment Variables in Deploy #1089

Open
abhi-parate-st3 opened this issue Oct 29, 2024 · 0 comments

Comments

@abhi-parate-st3
Copy link

Currently, there's a disconnect between Deno runtime and Deno Deploy documentation regarding environment variables with the DENO_ prefix:

  1. The runtime documentation lists several special environment variables starting with DENO_ that developers can use during development.
  2. However, when deploying to Deno Deploy, setting any environment variable with the DENO_ prefix results in an error:
    Invalid key: DENO_ is a reserved prefix
  3. This restriction is not documented in the Deno Deploy environment variables documentation.

Impact:

  • Developers following the runtime docs may use DENO_ prefixed variables during local development
  • These applications will fail when deployed due to the undocumented restriction
  • This creates a frustrating developer experience and requires unnecessary debugging time

Proposed Documentation Update:
Add a prominent note in the Deploy environment variables documentation stating:

Important

Environment variables with the DENO_ prefix are reserved and cannot be set in Deno Deploy. While these variables (like DENO_AUTH_TOKENS) work in local development, you'll need to use alternative approaches when deploying.

Additional Suggestions:

  1. List common DENO_ variables that developers might try to use and their alternatives in Deploy
  2. Consider adding this warning to the runtime docs where DENO_ variables are mentioned

This documentation update will help developers avoid deployment issues and provide a smoother development experience.

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

No branches or pull requests

1 participant