Fetch environment variables and write it to a .env file - Maintained fork from https://github.com/Jimdo/serverless-dotenv
This plugin was forked because the original repo isn't maintained. Also, the name of the plugin was changed, because the original name didn't make sense to us.
--- toc ---
This serverless plugin generates a
.env file based on the environment variables in the
serverless.yml. The idea is to use this environment variables for further tasks like integration tests etc. It works great with
serverless offline, so you can start serverless offline, the plugin will hook into the process and create the
.env file. You will find the
.env file in the
.serverless folder of your project.
It will collect the global environment variables of the poject as well as all environment variables of the functions. It will also add
IS_OFFLINE to your environment if you run the plugin via
Add the npm package to your project:
# Via yarn $ yarn add @unly/serverless-env-copy-plugin # Via npm $ npm install @unly/serverless-env-copy-plugin --save
Add the plugin to your
plugins: - '@unly/serverless-env-copy-plugin'
That's it! You can now type
serverless dotenv in your terminal to generate the
.env file based on your serverless configuration. Alternative you can just start
serverless offline to generate it.
You can check https://github.com/UnlyEd/boilerplates-generator/tree/master/templates/node-v10.x-aws-serverless to get an example of this plugin
We gladly accept PRs, but please open an issue first so we can discuss it beforehand.
yarn test # Run all tests, interactive and watch mode yarn test:once # Used for CI/CD yarn test:coverage # Generate coverage report
We use Semantic Versioning for this project: https://semver.org/. (
Major version: Must be changed when Breaking Changes are made (public API isn't backward compatible).
yarn run release
This command will prompt you for the version to update to, create a git tag, build the files and commit/push everything automatically.
Don't forget we are using SemVer, please follow our SemVer rules.
Pro hint: use
beta tag if you're in a work-in-progress (or unsure) to avoid releasing WIP versions that looks legit
yarn releaseAndPublish # Shortcut - Will prompt for bump version, commit, create git tag, push commit/tag and publish to NPM yarn release # Will prompt for bump version, commit, create git tag, push commit/tag npm publish # Will publish to NPM
This project is being maintained by:
Unly is a socially responsible company, fighting inequality and facilitating access to higher education. Unly is committed to making education more inclusive, through responsible funding for students. We provide technological solutions to help students find the necessary funding for their studies.
We proudly participate in many TechForGood initiatives. To support and learn more about our actions to make education accessible, visit :
Tech tips and tricks from our CTO on our Medium page!
Latest commit b2f54ec on Sep 24, 2017