generator-screwdriver

Yeoman generator for building Screwdriver Node Modules

This Yeoman generator creates a new npm module pre-loaded with:

• License
• README with a variety of badges
• CONTRIBUTING doc
• JSCS and JSHint configs
• Screwdriver config
• package.json
• Labels for Github issues and pull requests

Prerequisites

• Node.js >= v12.0.0 (with NPM)

Usage

1. Create a Github repository.

2. Install Yeoman and generator-screwdriver using npm.

$ npm install -g yo
$ npm install -g generator-screwdriver

3. Get a Github token.

• Go to the create Github Personal Access Tokens page
• Fill in "Token description" with "Screwdriver-token"
• Select scopes "repo" and "admin:org"
• Click Generate token

4. Clone your repository and generate your new project.

$ git clone git@github.com:$REPO.git
$ cd $REPO
$ yo screwdriver

5. Create Git commit and push to master.

6. Publish the npm package and add git tags.

$ npm publish
$ git tag v0.0.1 && git push origin --tags

License

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