sls-yaml

Serverless YAML extension parser

This tiny library will parse YAML extensions used in serverless framework.

Supported extensions

• Include external file ${file(path/to/file.yml)}
• Inject environment variable ${env:NODE_ENV}
• Inject global variables ${global:path.to.variable}
• Inject local variables ${self:path.to.variable}
• Inject current git branch* ${git:branch}
• Inject last git commit hash* ${git:sha1}

* - New extension not present in serverless yaml

Include external file

This extension will include content of external yaml files.

• config.yml

version : 1
env: dev
config: ${file(./common.yml)}

• common.yml

endpoint: http://service-url

• Generated final yaml

version : 1
env: dev
config: 
  endpoint: http://service-url

Inject environment variable

This extension will inject envronment values

• config.yml export NODE_ENV = development

version : 1
env: ${env:NODE_ENV}

• Generated final yaml

version : 1
env: development

Inject global variables

This extension will inject variable from global scope.

• config.yml

version : 1
env: stage
config: ${file(./common.yml)}

• common.yml

endpoint: http://service-${global:env}

• Generated final yaml

version : 1
env: stage
config: 
  endpoint: http://service-stage

Inject local variables

This extension will inject variable from local scope.

• config.yml

version : 1
env: stage
config: ${file(./common.yml)}

• common.yml

port: 8080
endpoint: http://service:${self:port}

• Generated final yaml

version : 1
env: stage
config: 
  port: 8080
  endpoint: http://service:8080

Inject current git branch

This extension will inject current git branch name

• config.yml

branch: ${git:branch}

Inject last git commit hash

This extension will inject last git commit hash

• config.yml

image.tag: ${git:sha1}