mcfly-github v2.0.0

mcfly-github

Installation

npm i --save mcfly-github

How to create a github token file

Execute the following

githubHelper.createTokenFile('<your_github_login>', 
  '<your_github_password>', 
  'github-repos', 
  './files/testAuth.json'); 

then use getClient() without any parameters

Functions

getUsername() ⇒ Promise.<String>

Gets the git user name

Kind: global function Returns: Promise.<String> - The username

buildClient(username, password) ⇒ Object

Gets a connected github client can fallback to process.env.GITHUB_TOKEN or ./files/testAuth.json

Kind: global function Returns: Object - The github client

checkClient(github) ⇒ Promise.<Object>

Checks the validity of the credentials

Kind: global function Returns: Promise.<Object> - The github client

getClient(username, password) ⇒ Promise.<Object>

Gets a valid github client by checking the credentials

Kind: global function Returns: Promise.<Object> - The github client

getRepo(github, param) ⇒ Promise.<Object>

Gets a specific repo

Kind: global function Returns: Promise.<Object> - The resulting repository

getBranches(github, repo) ⇒ Promise.<Array>

Gets all branches of a repo

Kind: global function Returns: Promise.<Array> - An array of the branches found

getTree(github, repo, sha) ⇒ Promise.<Array>

Gets tree of specific sha in a repo

Kind: global function Returns: Promise.<Array> - An array of files and folders

getFileAsBuffer(github, param) ⇒ Promise.<Buffer>

Gets the content of the file in an object. If a sha is provided, the file is returned for the specific sha

Kind: global function Returns: Promise.<Buffer> - A stream of the file

getPackageJson(github, param) ⇒ Promise.<Object>

Gets the content of package.json

Kind: global function Returns: Promise.<Object> - package.json as an object

createTokenFile(username, password, tokenName, filename) ⇒ Promise.<Object>

Creates a token file

Kind: global function Returns: Promise.<Object> - The result of the api call to create the token

createRelease(param) ⇒ Promise

Creates a release on github

Kind: global function Returns: Promise - The result of the release on github