An open API service indexing awesome lists of open source software.

https://github.com/neverendingqs/serverless-print-resolved-plugin

Prints resolved output of serverless.yml
https://github.com/neverendingqs/serverless-print-resolved-plugin

serverless-framework serverless-plugin

Last synced: 8 months ago
JSON representation

Prints resolved output of serverless.yml

Awesome Lists containing this project

README

          

[![CircleCI](https://circleci.com/gh/neverendingqs/serverless-print-resolved-plugin.svg?style=svg)](https://circleci.com/gh/neverendingqs/serverless-print-resolved-plugin)
[![npm version](https://badge.fury.io/js/serverless-print-resolved-plugin.svg)](https://badge.fury.io/js/serverless-print-resolved-plugin)

# serverless-print-resolved-plugin

This plugin generates a copy of `serverless.yml` with all Serverless variables
resolved to actual values. It can also write additional metadata that is
available.

## Usage

Install the plugin:

```sh
npm install -D serverless-print-resolved-plugin
```

Register the plugin in `serverless.yml`:

```yaml
plugins:
- serverless-print-resolved-plugin
```

After `package` / `deploy`, `.serverless/serverless-resolved.yml` will contain a
copy of `serverless.yml` but with all variables resolved.

To include more metadata from the `serverless` object, add the following to
`serverless.yml`:

```yaml
custom:
print-resolved:
# Paths are followed using `lodash.get()`
paths:
- serverless.pluginManager.hooks
- serverless.variables.option
```

Note: objects / properties considered invalid by
[js-yaml](https://github.com/nodeca/js-yaml) are skipped.