-
Notifications
You must be signed in to change notification settings - Fork 45
/
README.md
143 lines (112 loc) · 5.93 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# semantic-release-cli
[](https://github.com/semantic-release/cli/actions?query=workflow%3ATest+)
## Install
```bash
npm install -g semantic-release-cli
cd your-module
semantic-release-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'].
--gh-token=<String> GitHub auth token
--npm-token=<String> npm auth token
--circle-token=<String> CircleCI auth token
--npm-username=<String> npm username
Aliases:
init setup
## What it Does
__semantic-release-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
* Which npm registry you want to use (Default: https://registry.npmjs.org/)
* Your npm username (unless passwords were previously saved to keychain)
* Your npm email
* Your npm password
* Which continuous integration system you want to use. (Options: Travis CI / Pro / Enterprise / CircleCI, or Other)
* [Travis only] Whether you want to test a single node.js version (e.g. - 8) or multiple node.js versions (e.g. - 4, 6, 8, etc.)
1. npm Add User
* Runs `npm adduser` with the npm information provided to generate a `.npmrc`
* Parses the npm token from the `.npmrc` for future use
1. Uses user supplied GitHub Personal Access Token (with the following permissions: `repo`, `read:org`, `repo:status`, `repo_deployment`, `user:email`, `write:repo_hook`)
* Sets GitHub Personal Access Token in user choosen CI/CD environment variable
1. Update your `package.json`
* Set `version` field to `0.0.0-development` (`semantic-release` will set the version for you automatically)
* Add a `semantic-release` script: `"semantic-release": "semantic-release"`
* Add `semantic-release` as a `devDependency`
* Add or overwrite the [`repository` field](https://docs.npmjs.com/files/package.json#repository)
## Travis CI
### Versions 4.1.0+
`semantic-release-cli` does not perform any additional Travis-specific steps, but the cli output will provide a [link](https://github.com/semantic-release/semantic-release/blob/master/docs/03-recipes/travis.md) for assistance integrating Travis and `semantic-release-cli`.
### Prior to version 4.1.0
`semantic-release-cli` performs the following additional steps:
1. Overwrite your `.travis.yml` file
* `after_success`: `npm install -g travis-deploy-once` and `travis-deploy-once "npm run semantic-release"`: run `semantic-release` exactly once after all builds pass
* Set other sane defaults: `cache: directories: ~/.npm`, `notifications: email: false`
1. Login to Travis CI to configure the package. This step requires your module to define a valid, case-sensitive
[`repository` field](https://docs.npmjs.com/files/package.json#repository).
* Enable builds of your repo
* Add `GH_TOKEN` and `NPM_TOKEN` environment variables in the settings
## CircleCI
For CircleCI, `semantic-release-cli` performs the following additional steps:
1. Create minimal `config.yml` file (if CircleCI was selected)
```yml
version: 2
jobs:
build:
docker:
- image: 'circleci/node:latest'
steps:
- checkout
- run:
name: install
command: npm install
- run:
name: release
command: npm run semantic-release || true
```
2. Login to CircleCI to configure the package
* Enable builds of your repo
* Add `GH_TOKEN` and `NPM_TOKEN` environment variables in the settings
## Github Actions
For Github Actions, `semantic-release-cli` performs the following additional step:
* Login to Github to configure the package
* Add `NPM_TOKEN` environment variables as a secret in the settings
For now you will have to manually modify your existing workflow to add a release step. Here is an example of a small complete workflow `.github/workflows/workflow.yml`:
```yaml
name: CI
on: push
jobs:
test:
runs-on: ubuntu-16.04
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '12'
- run: npm ci
- run: npm test
- name: Release
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
```
## Other CI Servers
By default, `semantic-release-cli` supports the popular Travis CI and CircleCI servers. 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.
## Setting defaults
This package reads your npm username from your global `.npmrc`. In order to autosuggest a username in the future, make sure to set your username there: `npm config set username <username>`.
## Contribute
Please contribute! We welcome issues and pull requests.
When committing, please conform to [the semantic-release commit standards](https://github.com/semantic-release/semantic-release#default-commit-message-format).
## License
MIT License
2015 © Christoph Witzko and [contributors](https://github.com/semantic-release/cli/graphs/contributors)
