Skip to content

Commit

Permalink
breaking change: use ghauth@^3.2.0 (better 2FA support)
Browse files Browse the repository at this point in the history
Config directory is now determined by [`application-config`](https://github.com/LinusU/node-application-config) and is OS-specific. You may want to delete your old config directory (`~/.config/gh-release`).
  • Loading branch information
ungoldman committed Mar 23, 2016
1 parent 40003fd commit 5246e65
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).

This change log adheres to [keepachangelog.com](http://keepachangelog.com).

## Unreleased

### Changed

* Using `ghauth@^3.2.0` (better 2FA support). Config directory is now determined by [`application-config`](https://github.com/LinusU/node-application-config) and is OS-specific. You may want to delete your old config directory (`~/.config/gh-release`).

## [2.0.3] - 2016-03-22

### Changed
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ creating release v1.0.0 for ungoldman/cool-project
name: v1.0.0
tag_name: v1.0.0
target_commitish: 9561804a4d1fca2525d3207bec4907dd5ec7a705
body: * engage
body:
* engage
? publish release to github? Yes
https://github.com/ungoldman/cool-project/releases/tag/v1.0.0
Expand All @@ -47,9 +49,9 @@ Should be run at the root of the project to be released.

Expects a `package.json` and `CHANGELOG.md` in the working directory.

Prints release URL to terminal on success.
Prints release URL to `stdout` on success.

Saves Github API token to `$HOME/.config/gh-release.json` after first authentication.
Uses [`ghauth`](https://github.com/rvagg/ghauth) for authentication with Github. A Github API OAuth token is saved to the `gh-release` config directory after the first time authenticating. Note that the config directory is determined by [`application-config`](https://github.com/LinusU/node-application-config) and is OS-specific.

Get usage info by running with `--help` or `-h`.

Expand All @@ -58,7 +60,7 @@ $ gh-release --help
Usage: gh-release [options]
Examples:
node bin/cli.js -n v1.1.8 -c master -d create a draft release with title v1.1.8 tagged at HEAD of master
gh-release -n v2.0.3 -c master -d create a draft release with title v2.0.3 tagged at HEAD of master
Options:
Expand All @@ -71,7 +73,7 @@ Options:
-d, --draft publish as draft [default: false]
-p, --prerelease publish as prerelease [default: false]
--dry-run dry run (stops before release step) [default: false]
-w, --workpath path to working directory [default: <current working directory>]
-w, --workpath path to working directory [default: "<current working directory>"]
-a, --assets list of assets to upload to release [default: false]
-h, --help Show help
-v, --version Show version number
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"changelog-parser": "^2.0.0",
"deep-extend": "^0.3.3",
"gh-release-assets": "^1.1.0",
"ghauth": "^2.0.0",
"ghauth": "^3.2.0",
"inquirer": "^0.8.0",
"request": "^2.55.0",
"shelljs": "^0.3.0",
Expand Down

0 comments on commit 5246e65

Please sign in to comment.