netlify-plugin-contextual-env
Advanced tools
Weekly downloads
Readme
This plugin swaps out ENV vars on Netlify at build time. Here's how it works:
Say you have an ENV in your API code called DATABASE_URL
. If you use this plugin, you'll be able to override that value based on a Context or Branch name.
For example:
staging
branch, would automatically set DATABASE_URL
to the value of STAGING_DATABASE_URL
if it exists.production
context would automatically set DATABASE_URL
to the value of PRODUCTION_DATABASE_URL
if it exists.deploy-preview
context (used for Pull Requests) would automatically set DATABASE_URL
to the value of DEPLOY_PREVIEW_DATABASE_URL
if it exists.This allows you to have per-environment or per-context environment variables, without exposing those variables in your netlify.toml
config.
If you'd rather use a suffix rather than the default prefix configuration, pass suffix to the inputs below.
For the examples above, it would use the values DATABASE_URL_STAGING
, DATABASE_URL_PRODUCTION
, and DATABASE_URL_DEPLOY_PREVIEW
respectively.
Add a [[plugins]]
entry to your netlify.toml
file:
[[plugins]]
package = 'netlify-plugin-env'
[plugins.inputs]
mode = 'prefix'
name | description | default |
---|---|---|
mode | The way to append the context or branch name (prefix or suffix ) | prefix |
FAQs
A Netlify plugin to override ENV vars based on a branch or context
The npm package netlify-plugin-contextual-env receives a total of 777 weekly downloads. As such, netlify-plugin-contextual-env popularity was classified as not popular.
We found that netlify-plugin-contextual-env demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.