Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/screwdriver-cd/config-parser
Node module for parsing screwdriver.yaml configurations
https://github.com/screwdriver-cd/config-parser
parser yaml
Last synced: 3 months ago
JSON representation
Node module for parsing screwdriver.yaml configurations
- Host: GitHub
- URL: https://github.com/screwdriver-cd/config-parser
- Owner: screwdriver-cd
- License: other
- Created: 2016-06-27T00:39:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T22:04:42.000Z (6 months ago)
- Last Synced: 2024-05-21T20:49:41.065Z (6 months ago)
- Topics: parser, yaml
- Language: JavaScript
- Homepage: https://cd.screwdriver.cd/pipelines/18
- Size: 343 KB
- Stars: 3
- Watchers: 13
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Screwdriver.yaml Configuration Parser
[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]
> Node module for validating and parsing `screwdriver.yaml` configurations
- Validates a `screwdriver.yaml` for structural and functional specification
- Outputs the pipeline's workflowGraph configuration
- Generates a list of jobs to execute, including:
- build permutations
- environment variables to set
- steps to execute
- container image to use
## YAML
```yaml
shared:
environment:
NODE_ENV: test
settings:
email: [email protected]
jobs:
main:
image: node:18
steps:
- init: npm install
- test: npm test
requires:
- ~pr
- ~commit
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
requires:
- main
```
## Usage
```bash
npm install screwdriver-config-parser
```
Parse in Node.js:
```javascript
const parser = require('screwdriver-config-parser');
// Configuration (in YAML form)
parser(fs.readFileSync('screwdriver.yaml')).then((pipeline) => {
// Workflow for the pipeline
// pipeline.workflowGraph
// 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
});
```
## Testing
```bash
npm test
```
## License
Code licensed under the BSD 3-Clause license. See LICENSE file for terms.
[npm-image]: https://img.shields.io/npm/v/screwdriver-config-parser.svg
[npm-url]: https://npmjs.org/package/screwdriver-config-parser
[downloads-image]: https://img.shields.io/npm/dt/screwdriver-config-parser.svg
[license-image]: https://img.shields.io/npm/l/screwdriver-config-parser.svg
[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/screwdriver.svg
[issues-url]: https://github.com/screwdriver-cd/screwdriver/issues
[status-image]: https://cd.screwdriver.cd/pipelines/18/badge
[status-url]: https://cd.screwdriver.cd/pipelines/18