https://github.com/screwdriver-cd/generator-screwdriver
Yeoman generator for building Screwdriver Node Modules
https://github.com/screwdriver-cd/generator-screwdriver
configs contributing eslint license npm-module screwdriver yeoman-generator
Last synced: 2 months ago
JSON representation
Yeoman generator for building Screwdriver Node Modules
- Host: GitHub
- URL: https://github.com/screwdriver-cd/generator-screwdriver
- Owner: screwdriver-cd
- License: other
- Created: 2016-05-19T06:08:31.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T03:51:55.000Z (3 months ago)
- Last Synced: 2025-03-11T04:30:46.815Z (3 months ago)
- Topics: configs, contributing, eslint, license, npm-module, screwdriver, yeoman-generator
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-screwdriver
- Size: 73.2 KB
- Stars: 1
- Watchers: 12
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-screwdriver
[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]
> 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](https://nodejs.org/) >= v12.0.0 (with NPM)
## Usage
1. Create a Github repository.
2. Install [Yeoman](http://yeoman.io) and generator-screwdriver using [npm](https://www.npmjs.com/).
```bash
$ npm install -g yo
$ npm install -g generator-screwdriver
```
3. Get a Github token.
- Go to the create [Github Personal Access Tokens](https://github.com/settings/tokens/new) 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.
```bash
$ git clone [email protected]:$REPO.git
$ cd $REPO
$ yo screwdriver
```
5. Create Git commit and push to master.
6. Publish the npm package and add git tags.
```bash
$ 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.
[npm-image]: https://img.shields.io/npm/v/generator-screwdriver.svg
[npm-url]: https://npmjs.org/package/generator-screwdriver
[downloads-image]: https://img.shields.io/npm/dt/generator-screwdriver.svg
[license-image]: https://img.shields.io/npm/l/generator-screwdriver.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/11/badge
[status-url]: https://cd.screwdriver.cd/pipelines/11