Skip to content

serverless-tencent/yaml-parser

Repository files navigation

Serverless Yaml Parser

npm NPM downloads Build Status semantic-release

Yaml Parser for Serverless Framework.

Installation

$ npm i @serverless-tencent/yaml-parser -g

Usage

$ yparse -h Usage: yparse [options] [command] Options: -v, --version output the current version -h, --help display help for command Commands: parse [options] parse serverless config file with costomize and environment variables replacement help [command] display help for command Example call: $ yparse --help

Notice: Below examples will use sp instead of yparse.

Parse serverless config file

$ sp parse -o -s '{"src":"./"}'

Parse command will parse serverless config file with costomize and environment variables replacement.

For example, before is:

inputs: region: ${env:REGION}

If process.env.REGION=ap-guangzhou, after parsing, the serverless.yml will be:

inputs: src: ./ region: ap-guangzhou

Migrate serverless config file

$ yparse migrate

This command will auto migrate your old yaml config to latest version.

Development

All git commit mesage must follow below syntax:

type(scope?): subject #scope is optional

support type:

  • feat: add new feature
  • fix: fix bug or patch feature
  • ci: CI
  • chore: modify config, nothing to do with production code
  • docs: create or modifiy documents
  • refactor: refactor project
  • revert: revert
  • test: test

Most of time, we just use feat and fix.

Test

For CI test, should copy .env.example to .env.test, then config below environment variables to yours:

# tencent credentials TENCENT_SECRET_ID=xxx TENCENT_SECRET_KEY=xxx # cos url for project code download in CI environment CODE_URL_COS=xxx # git ulr for git project CODE_URL_GIT=xxx # nextjs CODE_URL_COS_NEXTJS=xxx STATIC_URL_NEXTJS=xxx # nuxtjs CODE_URL_COS_NUXTJS=xxx STATIC_URL_NUXTJS=xxx

License

MIT License

Copyright (c) 2020 Serverless Plus

About

Parser for serverless.yml

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •