semantic-sf-cli
Install
npm install -g semantic-sf-cli cd your-modulesemantic-sf-cli setup
Options
Usage:
semantic-release-cli setup [options]
Options:
-h --help Show this screen.
-v --version Show version.
--[no-]keychain Use keychain to get passwords [default: true].
--ask-for-passwords Ask for the passwords even if passwords are stored [default: false].
--tag=<String> npm tag to install [default: 'latest'].
Aliases:
init setup
What it Does
semantic-sf-cli performs the following steps:
- Asks for the information it needs. You will need to provide it with:
- Whether your GitHub repository is public or private
- Your GitHub username
- Your GitHub password (unless passwords were previously saved to keychain)
- Your Script Fodder API Key
- Save your passwords to your local OS's keychain using keytar for future use (unless
--no-keychain
was specified) - Create GitHub Personal Token
- Logs into GitHub using the username and password provided
- Creates a GitHub Personal Access Token and saves it for future use
- Update your package.json
- Remove
version
field (you don't need it anymore --semantic-release
will set the version for you automatically) - Add a
semantic-release
script:"semantic-release": "semantic-release pre && npm publish && semantic-release post"
- Add
semantic-release
as adevDependency
- Add or overwrite the
repository
field
- Remove
- Login to Travis CI to configure the package
- Enable builds of your repo
- Add GH_TOKEN and NPM_TOKEN environment variables in the settings
Other CI Servers
By default, semantic-release-cli
supports the popular Travis CI server. If you select Other
as your server during configuration, semantic-release-cli
will print out the environment variables you need to set on your CI server. You will be responsible for adding these environment variables as well as configuring your CI server to run npm run semantic-release
after all the builds pass.
Note that your CI server will also need to set the environment variable CI=true
so that semantic-release
will not perform a dry run. (Most CI services do this by default.) See the semantic-release
documentation for more details.
License
MIT License 2015 © Christoph Witzko and contributors