Home

Awesome

Putasset License NPM version Build Status

Upload an asset to releases on GitHub.

Install

npm i putasset -g

How to use?

Global

$ putasset
Usage: putasset [options]
Options:
  -h, --help      display this help and exit
  -v, --version   output version information and exit
  -r, --repo      name of repository
  -o, --owner     owner of repository
  -t, --tag       tag of repository (should exist!)
  -f, --filename  path to asset
  -k, --token     github token <https://github.com/settings/tokens/new>
  -l, --loud      output filename, repo, owner and tag before upload
  --show-url      show asset url
  --force         overwrite asset if one with same name already exist

$ putasset -k "token from url" \
-r putasset -o coderaiser -t v1.0.0 \
-f "release.zip" --show url

https://github.com/coderaiser/putasset/releases/download/v1.0.0/releases.zip

To set token environment variable PUTASSET_TOKEN could be used.

Local

npm i putasset --save

Data will be read before execution in next order (left is more important):

command line -> ~/.putasset.json

Example

const putasset = require('putasset');
const token = 'token from https://github.com/settings/applications';

const url = await putasset(token, {
    owner: 'coderaiser',
    repo: 'putasset',
    tag: 'v1.0.0',
    filename: 'realease.zip',
});

console.log(`Upload success, download url: ${url}`);

Related

License

MIT