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
-
buildClient([username], [password]) ⇒
Object
-
Gets a connected github client can fallback to process.env.GITHUB_TOKEN or ./files/testAuth.json
-
checkClient(github) ⇒
Promise.<Object>
-
Checks the validity of the credentials
-
getClient([username], [password]) ⇒
Promise.<Object>
-
Gets a valid github client by checking the credentials
-
getRepo(github, param) ⇒
Promise.<Object>
-
Gets a specific repo
-
getAllBranches(github, repo) ⇒
Promise.<Array>
-
Gets all the branches of the repo
-
getTree(github, repo, sha) ⇒
Promise.<Array>
-
Gets the tree of a specific sha in a repo
-
getFileAsBuffer(github, param) ⇒
Promise.<Buffer>
-
Gets the content of the file in an object
-
getPackageJson(github, param) ⇒
Promise.<Object>
-
Gets the content of package.json
-
createTokenFile(username, password, tokenName, filename) ⇒
Promise.<Object>
-
Creates a token file
-
createRelease(param) ⇒
Promise
-
Creates a release on github
Promise.<String>
getUsername() ⇒ Gets the git user name
Kind: global function
Returns: Promise.<String>
- The username
Object
buildClient([username], [password]) ⇒ Gets a connected github client can fallback to process.env.GITHUB_TOKEN or ./files/testAuth.json
Kind: global function
Returns: Object
- The github client
Param | Type | Description |
---|---|---|
[username] | String |
The github username |
[password] | String |
The github password |
Promise.<Object>
checkClient(github) ⇒ Checks the validity of the credentials
Kind: global function
Returns: Promise.<Object>
- The github client
Param | Type | Description |
---|---|---|
github | Object |
The github client |
Promise.<Object>
getClient([username], [password]) ⇒ Gets a valid github client by checking the credentials
Kind: global function
Returns: Promise.<Object>
- The github client
Param | Type | Description |
---|---|---|
[username] | String |
The github username |
[password] | String |
The github password |
Promise.<Object>
getRepo(github, param) ⇒ Gets a specific repo
Kind: global function
Returns: Promise.<Object>
- The resulting repository
Param | Type | Description |
---|---|---|
github | Object |
The github client |
param | Object |
An object with the following properties: user, repo |
Promise.<Array>
getBranches(github, repo) ⇒ Gets all branches of a repo
Kind: global function
Returns: Promise.<Array>
- An array of the branches found
Param | Type | Description |
---|---|---|
github | Object |
The github client |
repo | String |
The repo full name |
Promise.<Array>
getTree(github, repo, sha) ⇒ Gets tree of specific sha in a repo
Kind: global function
Returns: Promise.<Array>
- An array of files and folders
Param | Type | Description |
---|---|---|
github | Object |
The github client |
repo | String |
The repo full name |
sha | String |
The sha of the repo |
Promise.<Buffer>
getFileAsBuffer(github, param) ⇒ 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
Param | Type | Description |
---|---|---|
github | Object |
The github client |
param | Object |
An object with the following properties: user, repo, filepath,sha |
Promise.<Object>
getPackageJson(github, param) ⇒ Gets the content of package.json
Kind: global function
Returns: Promise.<Object>
- package.json as an object
Param | Type | Description |
---|---|---|
github | Object |
The github client |
param | Object |
An object with the following properties: user, repo |
Promise.<Object>
createTokenFile(username, password, tokenName, filename) ⇒ Creates a token file
Kind: global function
Returns: Promise.<Object>
- The result of the api call to create the token
Param | Type | Description |
---|---|---|
username | String |
The github username |
password | String |
The github password |
tokenName | String |
The name of the token (visible in Person access tokens on https://github.com/settings/tokens) |
filename | String |
The filename to store the resulting token |
Promise
createRelease(param) ⇒ Creates a release on github
Kind: global function
Returns: Promise
- The result of the release on github
Param | Type | Description |
---|---|---|
param | Object |
An object with the following properties: github, owner, repo, nextVersion, changelogContent |