Screwdriver.yaml Configuration Parser

Node module for validating and parsing screwdriver.yaml configurations

• Validates a screwdriver.yaml for structural and functional specification
• Outputs the pipeline's workflow
• Generates a list of jobs to execute, including:
  • build permutations
  • environment variables to set
  • steps to execute
  • container image to use

YAML

workflow:
- publishshared:
environment:
NODE_ENV: testjobs:
main:
image: node:{{NODE_VERSION}}matrix:
NODE_VERSION: [4,5,6]steps:
- init: npm install
- test: npm testpublish:
environment:
NODE_TAG: latestimage: node:4steps:
- bump: npm run bump
- publish: npm publish --tag $NODE_TAG
- tag: git push origin --tags

Usage

npm install screwdriver-config-parser

Parse in Node.js:

constparser=require('screwdriver-config-parser');// Configuration (in YAML form)parser(fs.readFileSync('screwdriver.yaml'),(err,pipeline)=>{// Workflow for the pipeline// pipeline.workflow// All the main jobs with the steps to execute and environment variables to set// pipeline.jobs.main[].commands// pipeline.jobs.main[].environment// pipeline.jobs.main[].image// All the publish jobs with the steps to execute and environment variables to set// pipeline.jobs.publish[].commands// pipeline.jobs.publish[].environment// pipeline.jobs.publish[].image});

Or for usage on the command line see USAGE.md.

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.