https://github.com/roopakv/node-enrich-github

NPM module which makes it easy to work with enrich-github
https://github.com/roopakv/node-enrich-github

Last synced: about 1 month ago
JSON representation

NPM module which makes it easy to work with enrich-github

• Host: GitHub
• URL: https://github.com/roopakv/node-enrich-github
• Owner: roopakv
• License: mit
• Created: 2019-03-17T00:26:51.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T17:42:07.000Z (almost 3 years ago)
• Last Synced: 2024-03-13T09:03:20.038Z (10 months ago)
• Language: JavaScript
• Size: 244 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# enrich-github

NPM module which makes it easy to work with enrich-github.

At the moment, enrich github supports the following 3 APIs. Open issues on this

repository, for other features you would like to see.

## Usage

Get a token for enrich github by going to [enrichgithub.com](http://enrichgithub.com).

Instantiate enrichgithub with your token and repo name

```javascript

const EnrichGithub = require('enrich-github');

const token = process.env.ENRICH_GITHUB_TOKEN;

const repo = roopakv/node-enrich-github;

const enrichGithub = new EnrichGithub(token, repo);

```

All methods take in an options object. The structure of each API is described

below.

### addCommit

This is used to add a commit on github. Currently this method supports adding

only one file change at a time.

A commit may either be added to an existing branch, or a new branch can be

branched off of an existing branch.

```javascript

await enrichGithub.addCommit({

  file_path: 'lib/README.md',

  file_content: 'The new contents for lib/README.md',

  message: 'The commit message',

  branch: 'roopakv/sample', // The branch this commit will be added to

  create_branch: true, // Deafaults to false.

  base: 'master' // needed only if create_branch is true

});

```

### openPR

Opens a pull request on github.

```javascript

await enrichGithub.openPR({

  title: 'The title of the PR',

  branch: 'roopakv/sample',

  body: 'The body for the PR' // optional

  base: 'master' // defaults to master.

})

```

### postCheck

This works with github check runs API. This API is pretty much a pass thru to

the github check runs api, and all that enrich github does here is

makes hitting this API eaiser.

Read about the post checks endpoint [here](https://developer.github.com/v3/checks/runs/#create-a-check-run)

```javascript

await enrichGithub.postCheck({

  post_body: {

    name: ...

    head_sha: ...,

    details_url: ...

    ...

  }

})

```