https://github.com/valentinfunk/semantic-sf-cli
https://github.com/valentinfunk/semantic-sf-cli
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/valentinfunk/semantic-sf-cli
- Owner: ValentinFunk
- Created: 2017-03-29T12:52:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-03T21:02:24.000Z (about 8 years ago)
- Last Synced: 2025-02-14T14:02:22.783Z (3 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# semantic-sf-cli
[](https://travis-ci.org/Kamshak/semantic-sf-cli)
[](https://nodei.co/npm/semantic-sf-cli/)
## Install
```bash
npm install -g semantic-sf-cli
cd your-module
semantic-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= npm tag to install [default: 'latest'].
Aliases:
init setup
## What it Does
__semantic-sf-cli performs the following steps:__
1. 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
1. Save your passwords to your local OS's keychain using [keytar](https://www.npmjs.com/package/keytar) for future use (unless `--no-keychain` was specified)
1. Create GitHub Personal Token
* Logs into GitHub using the username and password provided
* Creates a [GitHub Personal Access Token](https://github.com/settings/tokens) and saves it for future use
1. 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 a `devDependency`
* Add or overwrite the [`repository` field](https://docs.npmjs.com/files/package.json#repository)
1. 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](https://github.com/semantic-release/cli/graphs/contributors)
