Create a release for a node package on GitHub.
- Uses the Github Releases API to create a new github release.
- Defaults to using information from
package.jsonandCHANGELOG.md.
$ npm install gh-release
$ gh-release
Your GitHub username: ungoldman
Your GitHub password: ✔✔✔✔✔✔✔✔
creating release v1.0.0 for ungoldman/cool-project
name: v1.0.0
tag_name: v1.0.0
target_commitish: 9561804a4d1fca2525d3207bec4907dd5ec7a705
body:
* engage
? publish release to github? Yes
https://github.com/ungoldman/cool-project/releases/tag/v1.0.0
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 stdout on success.
Uses 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 and is OS-specific.
Get usage info by running with --help or -h.
$ gh-release --help
Usage: gh-release [options]
Examples:
gh-release -n v2.0.3 -c master -d create a draft release with title v2.0.3 tagged at HEAD of master
Options:
-t, --tag_name tag for this release
-c, --target_commitish commitish value for tag
-n, --name text of release title
-b, --body text of release body
-o, --owner repo owner
-r, --repo repo name
-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>"]
-a, --assets list of assets to upload to release [default: false]
-h, --help Show help
-v, --version Show version number
var ghRelease = require('gh-release')
// all options have defaults and can be omitted
var options = {
tag_name: 'v1.0.0',
target_commitish: 'master',
name: 'v1.0.0',
body: '* init\n',
draft: false,
prerelease: false,
repo: 'gh-release',
owner: 'ungoldman'
}
// options can also be just an empty object
var options = {}
// auth is required
// it can either be a username & password...
options.auth = {
username: 'ungoldman',
password: 'XXXXXXXX'
}
// or an API token
options.auth = {
token: 'XXXXXXXX'
}
ghRelease(options, function (err, result) {
if (err) throw err
console.log(result) // create release response: https://developer.github.com/v3/repos/releases/#response-4
})All default values taken from package.json unless specified otherwise.
| name | description | default |
|---|---|---|
tag_name |
release tag | 'v' + version |
target_commitish |
commitish value to tag | HEAD of current branch |
name |
release title | 'v' + version |
body |
release text | CHANGELOG.md section matching version |
owner |
repo owner | repo owner parsed out of repository.url |
repo |
repo name | repo name parsed out of repository.url |
draft |
publish as draft | false |
prerelease |
publish as prerelease | false |
assets |
release assets to upload | false |
Override defaults with flags (CLI) or the options object (node).
CHANGELOG.md: http://keepachangelog.compackage.json: https://docs.npmjs.com/files/package.json
All releases of gh-release were created with gh-release.
| Platform | Location |
|---|---|
| OS X | ~/Library/Application Support/gh-release/config.json |
| Linux (XDG) | $XDG_CONFIG_HOME/gh-release/config.json |
| Linux (Legacy) | ~/.config/gh-release/config.json |
| Windows (> Vista) | %LOCALAPPDATA%/gh-release/config.json |
| Windows (XP, 2000) | %USERPROFILE%/Local Settings/Application Data/gh-release/config.json |
There are packages that already do something like this, and they're great, but I want something that does this one thing really well and nothing else, leans heavily on standards in package.json and CHANGELOG.md, and can work both as a CLI tool and programmatically in node.
Contributions welcome! Please read the contributing guidelines first.
gh-release uses standard and tape for testing. You can run all tests with npm test.