node-red-contrib-github

Interacts with Github using node-red and Internet of things.

This is a wrapper around github-api. Check it out for more info.

Install

Run the following command in the root directory of your Node-RED install, usually this is ~/.node-red .

    npm install node-red-contrib-github

Usage

Provides a node to interact with Github repositories

Example:

    [{"id":"8f8ed4e1.707128","type":"github-repo","z":"ffa794cc.005868","github":"","name":"Show node-red repo info","username":"node-red","usernameType":"str","repository":"node-red","repositoryType":"str","action":"show","branch":"master","branchType":"str","path":"","pathType":"str","contents":"payload","contentsType":"msg","outputs":"1","x":289,"y":139,"wires":[["cc7922e4.3386e"]]},{"id":"c08be771.3f7418","type":"github-user","z":"ffa794cc.005868","github":"","name":"Get your personal info","action":"show","outputs":"1","options":"","optionsType":"json","username":"","usernameType":"str","orgname":"","orgnameType":"str","x":286,"y":216,"wires":[["cc7922e4.3386e"]]},{"id":"3c27218.fc3d8de","type":"inject","z":"ffa794cc.005868","name":"","topic":"","payload":"","payloadType":"str","repeat":"","crontab":"","once":false,"x":90,"y":138,"wires":[["8f8ed4e1.707128"]]},{"id":"cc7922e4.3386e","type":"debug","z":"ffa794cc.005868","name":"","active":true,"console":"false","complete":"false","x":620,"y":211,"wires":[]},{"id":"33bd75c6.cc428a","type":"inject","z":"ffa794cc.005868","name":"","topic":"","payload":"","payloadType":"str","repeat":"","crontab":"","once":false,"x":86,"y":213,"wires":[["c08be771.3f7418"]]},{"id":"1f36c11d.e0c93f","type":"github-repo","z":"ffa794cc.005868","github":"","name":"Get contents of msg.payload at 'master'","username":"node-red","usernameType":"str","repository":"payload","repositoryType":"msg","action":"contents","branch":"master","branchType":"str","path":"","pathType":"str","contents":"payload","contentsType":"msg","outputs":"1","x":358,"y":298,"wires":[["cc7922e4.3386e"]]},{"id":"8575983e.7a8a68","type":"inject","z":"ffa794cc.005868","name":"","topic":"","payload":"node-red","payloadType":"str","repeat":"","crontab":"","once":false,"x":91,"y":299,"wires":[["1f36c11d.e0c93f"]]}]

Repo

Github Repo node. Can be used to search either:

• Show repo information
• Get contents from a certain path
• Read content at a certain path
• Write: Store content at a certain path. If the file specified in the path exists, the content is updated. If the file doesn't exist, it's created on the fly
• Move a file from A to B
• Remove a file
• Delete a repository
• Fork repository.
• List forks.
• Retrieve all available branches (aka heads) of a repository
• Get contributors list with additions, deletions, and commit counts

###User API

• List repositories of the authenticated user, including private repositories and repositories in which the user is a collaborator and not an owner
• List organizations the authenticated user belongs to
• List authenticated user's gists
• List unread notifications for the authenticated user
• Show user information for a particular username. Also works for organizations. Pass in a falsy value (null, '', etc) for 'username' to retrieve user information for the currently authorized user
• List public repositories for a particular user
• List starred repositories for a particular user
• Create a new repo for the authenticated user
• List repositories for a particular organization. Includes private repositories if you are authorized.
• List all gists of a particular user. If username is ommitted gists of the current authenticated user are returned

TODO

Features to be implemented

Repo

• Create new branch for repo
• List Pull Requests
• Get details of a Pull Request
• Create Pull Request
• Get list of statuses for a particular commit
• Get information about a particular commit
• getTree
• retrieve the reference blob or tree sha
• get the corresponding commit sha
• Create a new reference
• Delete a reference
• Check if a repository is starred
• Star a repository
• Unstar a repository

Gist API

• Everything