Socket
Socket
Sign inDemoInstall

serverless-plugin-env-stage-config

Package Overview
Dependencies
185
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

serverless-plugin-env-stage-config

Serverless plugin to define environment variables files for stages


Version published
Maintainers
1
Weekly downloads
399
increased by92.75%
Install size
14.0 MB

Weekly downloads

Readme

Source

serverless-plugin-env-stage-config

npm version XO code style

This Serverless plugin allows to define environment variable configuration files for stages. It exposes a new variable resolver ($esc) that automatically picks the correct value based on the selected stage. For development stages (local, dev, development), the variables will default to the system’s environment variables.

CI

Tests Release

Installation

pnpm add -D serverless-plugin-env-stage-config
plugins:
  - serverless-plugin-env-stage-config

Usage

For non-development stages, the variables will be retrieved from a serverless.env.${stage}.yml file, alongside the serverless.yml.

Let’s consider the following serverless.yml:

name: my-service

useDotenv: true

resources:
  Resources:
    MyQueue:
      Type: AWS::SQS::Queue
      Properties:
        QueueName: some-queue

provider:
  name: aws

  environment:
    MYSQL_HOST: ${esc:MYSQL_HOST}
    MYSQL_PORT: ${esc:MYSQL_PORT}

functions:
  run-something:
    handler: handler.run
    environment:
      QUEUE_URL: ${esc:QUEUE_URL}
      SECRET_TOKEN: ${esc:SECRET_TOKEN}

Local stages

In a local environment, the variables resolved with the esc: prefix will be equivalent to using env:. Using useDotenv: true alongside a .env file will alow you to define your environement variables.

The supported local stages are:

  • local
  • dev
  • development

Other stages

If you need to define a different source for the environement variables for your prod stage, you can define a serverless.env.prod.yml to redefine the variables.

For example, if you’re using AWS SSM Parameter Store, you could create the following file:

MYSQL_HOST: ${ssm:/my-service/prod/MYSQL_HOST}
QUEUE_URL: !Ref MyQueue
SECRET_TOKEN: ${ssm:/my-service/prod/SECRET_TOKEN}

Any variable that is not included in the serverless.env.prod.yml file will produce a warning and fallback to using env:. In this case, you will get the following warning:

Serverless: env-stage-config: WARNING: the MYSQL_PORT variable is not defined in serverless.env.prod.yml, defaulting to ${env:MYSQL_PORT, null}.

If a variable is not defined in the stage environment configuration file, or the environment (process.env), it will default to null.

License

MIT

Miscellaneous

    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

Keywords

FAQs

Last updated on 29 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc