generator-semantic-release

Adds semantic-release to an existing project.

Usage no npm install needed!

<script type="module">
  import generatorSemanticRelease from 'https://cdn.skypack.dev/generator-semantic-release';
</script>

README

NPM version Dependency Status

generator-semantic-release

Adds semantic-release to an existing project.

This is very similar to semantic-release-cli, except:

  • It can be used as part of another generator via composition.
  • It asks explictily for your github and npm keys, so you can generate them however you want.
  • It asks explicitly if you want to save your keys. If you do, they are saved securely using keytar. You can also save multiple sets of keys - handy if you have some personal projects, and some "official" projects, and you want to use different credentials for the two.
  • Uses build stages.

To run this, you need to already have a package.json, and a .travis.yml file.

Installation

First, install Yeoman and generator-semantic-release using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-semantic-release

Then run in an existing project:

yo semantic-release

Development

To test changes, run:

npm pack .
npm install -g ./generator-semantic-release-*.tgz

And then you can run yo semantic-release in another project.

License

MIT © Jason Walton