Skip to content

NPM package to create and edit releases on Github (and upload artifacts)

License

Notifications You must be signed in to change notification settings

miyajan/node-github-release

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-github-release

CLI to create and edit releases on Github (and upload artifacts)

npm version npm downloads Node.js Version Support dependencies Status License

Acknowledgement

This tool is greatly inspired by aktau's go implementation. Thank you so, so much!

Requirement

  • Node: v4, v6, v8

Usage

# set your token (with a scope of `repo` or `public_repo`)
export GITHUB_TOKEN=...

# (optional) you can point to a different GitHub host (for GitHub Enterprise)
# export GITHUB_HOST=github.company.com
# export GITHUB_API_PATH_PREFIX=/api/v3

# help
$ github-release --help

# make your tag and upload
$ git tag ... && git push --tags

# check the current tags and existing releases of the repo on the current directory
$ github-release info
tags:
- 0.1.0 (commit: https://api.github.com/repos/miyajan/node-github-release/commits/...)
releases:
- 0.1.0, name: '...', description: '...', id: ..., tagged: ... , published: ... , draft: ✔, prerelease: ✗
  - artifact: ...

# create a formal release
$ github-release release \
    --tag 0.1.0 \
    --name "..." \
    --description "..." \
    --pre-release
  
# you've made a mistake, but you can edit the release without
# having to delete it first (this also means you can edit without having
# to upload your files again)
$ github-release edit \
    --tag 0.1.0 \
    --name "..." \
    --description "..."

# upload a file
$ github-release upload \
    --tag 0.1.0 \
    --name "..." \
    --file ...

# upload other files...
$ github-release upload ...

# you're not happy with it, so delete it
$ github-release delete \
    --tag 0.1.0

Install

$ npm install -g node-github-release

License

MIT

Author

miyajan: Jumpei Miyata miyajan777@gmail.com

About

NPM package to create and edit releases on Github (and upload artifacts)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages