Skip to content

Commit 02955e3

Browse files
committed
update usage
1 parent 542b2ca commit 02955e3

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
44
This change log adheres to standards from [Keep a CHANGELOG](http://keepachangelog.com).
55

66
## [Unreleased]
7-
* add `dry-run` option
7+
* add `dry-run` and `workpath` options
8+
* add a `get-defaults.js` test
89
* improve change log
9-
* Added workpath option to CLI.
10-
* Added a get-defaults.js test
1110

1211
## [1.1.1] - 2015-03-02
1312
* use `changelog-parser` for more reliable change log parsing

β€ŽREADME.mdβ€Ž

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Uses the [Github Releases API](https://developer.github.com/v3/repos/releases/)
1515
```
1616
$ npm install -g gh-release
1717
$ gh-release --help
18-
Usage: gh-release -t [tag_name] -c [commit] -n [name] -b [body] -o [owner] -r [repo] -d -p
18+
Usage: gh-release [options]
1919
2020
Options:
2121
-t, --tag_name tag for this release
@@ -24,23 +24,27 @@ Options:
2424
-b, --body text of release body
2525
-o, --owner repo owner
2626
-r, --repo repo name
27-
-d, --draft publish as draft [default: false]
28-
-p, --prerelease publish as prerelease [default: false]
27+
-d, --draft publish as draft [default: false]
28+
-p, --prerelease publish as prerelease [default: false]
29+
-w, --workpath path to working directory [default: current working directory]
2930
-h, --help Show help
3031
-v, --version Show version number
32+
--dry-run [default: false]
3133
3234
$ gh-release
3335
Your GitHub username: ngoldman
3436
Your GitHub password: βœ”βœ”βœ”βœ”βœ”βœ”βœ”βœ”
3537
36-
{ tag_name: 'v1.1.0',
37-
target_commitish: '394c232692d89ff3c904d4d3b046db4bc43c2aa0',
38-
name: 'v1.1.0',
39-
body: '* target node `0.12` and `iojs` on travis\n* user docker and cache `node_modules` on travis\n* add oauth2 token authentication method [#5](https://github.com/ngoldman/gh-release/issues/5)\n\n',
38+
{ tag_name: 'v1.1.2',
39+
target_commitish: 'ffed090688fb1b853aa07a546ac2e3965a02bb1d',
40+
name: 'v1.1.2',
41+
body: '* add `dry-run` and `workpath` options\n* improve change log',
4042
owner: 'ngoldman',
4143
repo: 'gh-release',
4244
draft: false,
43-
prerelease: false }
45+
prerelease: false,
46+
dryRun: false,
47+
workpath: '/Users/ng/dev/github/gh-release' }
4448
? does this look right? (y/N) y
4549
https://github.com/ngoldman/gh-release/releases/tag/v1.1.0
4650
```

β€Žbin/cli.jsβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ var authOptions = {
1313
userAgent: 'gh-release'
1414
}
1515
var yargs = require('yargs')
16-
.usage('Usage: $0 -t [tag_name] -c [commit] -n [name] -b [body] -o [owner] -r [repo] -d -p')
16+
.usage('Usage: $0 [options]')
1717
.options({
1818
't': {
1919
alias: 'tag_name',

0 commit comments

Comments
Β (0)