Github.getDownloadUrl()

Build the URL to download a specific release/branch .zip file for a particular repo.

Usage

Hover over inputs/exits for more info.

var Github = require('machinepack-github');


// Build the URL to download a specific release/branch .zip file for a particular repo.

Github.getDownloadUrl({

repo: 'sails',

owner: 'balderdashy',

branch: 'master',

}).execSync();

Inputs

repo required

The name of the Github repo (i.e. as it appears in the URL on GitHub)

'sails'
owner required

The name of the organization or user that owns the repo (i.e. as it appears in the URL on GitHub)

'balderdashy'
branch

The branch of the repo that will be downloaded.

'master'

Exits

error

An unexpected error occurred.

success

OK.

'https://github.com/balderdashy/sails/master.zip'