config-parser's Introduction

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:
    - publish

shared:
    environment:
        NODE_ENV: test

jobs:
    main:
        image: node:{{NODE_VERSION}}
        matrix:
            NODE_VERSION: [4,5,6]
        steps:
            - init: npm install
            - test: npm test

    publish:
        environment:
            NODE_TAG: latest
        image: node:4
        steps:
            - bump: npm run bump
            - publish: npm publish --tag $NODE_TAG
            - tag: git push origin --tags
        secrets:
            - NPM_TOKEN
            - GIT_KEY

Usage

npm install screwdriver-config-parser

Parse in Node.js:

const parser = 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
});