https://github.com/unlyed/serverless-scripts-env-plugin
https://github.com/unlyed/serverless-scripts-env-plugin
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/unlyed/serverless-scripts-env-plugin
- Owner: UnlyEd
- License: mit
- Created: 2019-01-16T23:03:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-09T23:45:28.000Z (over 6 years ago)
- Last Synced: 2024-05-01T09:48:48.864Z (about 2 years ago)
- Language: JavaScript
- Size: 818 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/UnlyEd/serverless-scripts-env)
[](https://codeclimate.com/github/UnlyEd/serverless-scripts-env/maintainability)
[](https://codeclimate.com/github/UnlyEd/serverless-scripts-env/test_coverage)
[](https://snyk.io/test/github/UnlyEd/serverless-scripts-env-plugin?targetFile=package.json)
# Serverless Scripts Env
## Introduction
This plugin aims to answer a specific need and to simplify the assignment of environment variables with serverless either front-end or back-end.
- [Installation](#installation)
- [Usage](#usage)
* [Step 1: Load the Plugin](#step-1-load-the-plugin)
* [Step 2: Configure your `serverless.yml`](#step-2-configure-your-serverlessyml)
- [Configuration of `slsScripts` object:](#configuration-of-slsscripts-object)
+ [`offline` & `build` object:](#offline--build-object)
* [Try it out yourself](#try-it-out-yourself)
- [API](#api)
- [Contributing](#contributing)
* [Getting started](#getting-started)
* [Test](#test)
* [Releasing and publishing](#releasing-and-publishing)
- [Node support](#node-support)
- [License](#license)
- [Vulnerability disclosure](#vulnerability-disclosure)
- [Contributors and maintainers](#contributors-and-maintainers)
- [**[ABOUT UNLY]**](#about-unly-)
## Installation
Install the plugin using either Yarn or NPM. (we use Yarn)
NPM:
```bash
npm install @unly/serverless-scripts-env
```
YARN:
```bash
yarn add @unly/serverless-scripts-env
```
## Usage
### Step 1: Load the Plugin
The plugin determines your environment during deployment and adds all environment variables to your Lambda function.
All you need to do is to load the plugin:
> Must be declared **before** `serverless-webpack`, despite what their officially doc says
```yaml
plugins:
- '@unly/serverless-scripts-env' # Must be first, even before "serverless-webpack", see https://github.com/UnlyEd/serverless-scripts-env
- serverless-webpack # Must be second, see https://github.com/99xt/serverless-dynamodb-local#using-with-serverless-offline-and-serverless-webpack-plugin
```
### Step 2: Configure your `serverless.yml`
Set the `slsScripts` object configuration as follows (list of all available options below):
```yaml
custom:
slsScripts:
offline:
logName: client # name of the command that appears in the terminal being executed
script:
cmd: next # command to execute
args:
- -p 3001
path: # Absolute path to run the command by default take root folder
env:
exclude: # list of environment variables present that will not be provided at launch time in the child process
- SECRET_KEY
provider:
name: aws
runtime: nodejs6.10
environment:
GROUP_NAME: staging
SECRET_KEY: f08ed2dc-edeb-45f4-9cac-56012820a384
```
## Configuration of `slsScripts` object:
| Attributes | Type | Required | Description |
|------------|:------:|:--------:|------------------------------------------------------------------|
| offline | Object | false | script to run before cli serverless-offline start |
| build | Object | false | script to run before cli serverless deploy or serverless package |
#### `offline` & `build` object:
| Attributes | Type | Required | Default | Description |
|------------|:------:|----------|---------------------------|-----------------------------------------------------------------|
| logName | String | false | Serverless-scripts-env | name of the command that appears in the terminal being executed |
| script | Object | true | | |
| path | String | false | current working directory | Absolute Path to run the script |
| env | Object | false | | |
##### `script` object :
| Attributes | Type | Required | Default | Description |
|------------|:------:|----------|:-------:|------------------------------|
| cmd | String | true | | command to execute |
| args | Array of String | false | [ ] | command arguments to execute |
##### `env` object :
| Attributes | Type | Required | Default | Description |
|------------|:---------------:|----------|---------|------------------------------------|
| exclude | Array of String | false | | environment variables to blacklist |
### Try it out yourself
To test this plugin, you can clone this repository.
Go to `examples/`, and follow the README.
---
## API
[API](./API.md)
---
## Contributing
We gladly accept PRs, but please open an issue first so we can discuss it beforehand.
### Getting started
```
yarn start # Shortcut - Runs linter + tests in concurrent mode (watch mode)
OR run each process separately for finer control
yarn lint
yarn test
```
### Test
```
yarn test # Run all tests, interactive and watch mode
yarn test:once
yarn test:coverage
```
### Releasing and publishing
```
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
```
## Node support
This plugin officially supports Node.js **6.10** and **8.10**.
## License
MIT
# Vulnerability disclosure
[See our policy](https://github.com/UnlyEd/Unly).
---
# Contributors and maintainers
This project is being maintained by:
- [Unly] Ambroise Dhenain ([Vadorequest](https://github.com/vadorequest)) **(active)**
Thanks to our contributors:
- Anthony Troupenat ([Fukoyamashisu](https://github.com/Fukoyamashisu))
---
# **[ABOUT UNLY]**
> [Unly](https://unly.org) 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 :
- https://twitter.com/UnlyEd
- https://www.facebook.com/UnlyEd/
- https://www.linkedin.com/company/unly
- [Interested to work with us?](https://jobs.zenploy.io/unly/about)
Tech tips and tricks from our CTO on our [Medium page](https://medium.com/unly-org/tech/home)!
#TECHFORGOOD #EDUCATIONFORALL