serverless-plugin-dotenv v1.0.0

Serverless Plugin: DotEnv

What is it?

Forked from https://github.com/silvermine/serverless-plugin-write-env-vars

This is a plugin for the Serverless framework (1.x branch, prior to 1.0.0 final) that writes environment variables out to a file that is compatible with dotenv.

Please monitor Serverless #1455 to determine if this plugin is still relevant.

How do I use it?

Easy! In your serverless.yml file you add a custom variable that is a list of variables you want written to an environment file. That file will be written and bundled into the root of your code bundle. Then you can rely on the dotenv library to load the file and make those variables accessible to your running Lambda functions.

This makes it simple to take advantage of the powerful variables capabilities that are built into Serverless.

For example:

service: petstore-api

custom:
   projectName: petstore
   stage: ${opt:stage, env:USER}
   dotenv:
      SERVERLESS_STAGE: ${self:custom.stage}
      SERVERLESS_PROJECT: ${self:custom.projectName}
      SERVERLESS_SERVICE_NAME: ${self:service}

plugins:
   - serverless-plugin-dotenv

dotenv can also be an array:

custom:
   stage: ${opt:stage, env:USER}
   dotenv:
      - ${file:./env/${self:custom.stage}.yml}
      -
        SERVERLESS_STAGE: ${self:custom.stage}

That's all! Fill those variables up with any keys and values you want!

NOTE: at this time the plugin does absolutely no sanitization of keys or values, so you should make sure they are simple strings that do not have line breaks or other characters that would need to be escaped.

License

This software is released under the MIT license. See the license file for more details.