GitHub sample
Using the GitHub sample bundle
The GitHub example bundle in samples/github
demonstrates the ability to access
the GitHub rest API. Here is a guide to how to get it working.
Prerequisites
You will need a working nodecg-io
installation. If you have non yet take a
look at installation guide. You may need to
install this bundle, so take a look at the
“Try an included sample”-Guide. It
will also tell you how to log in and how to use the GUI.
You also need:
- A GitHub token
Note
If you don't have a token yet, you can create one
here. The token requires at least the
repo
scope.
Configure the GitHub sample bundle
- In NodeCG, create a new GitHub service instance.
-
Enter the GitHub token:
{ "token": "abcdef...." }
After entering it, click save.
-
Set the sample's (
github
) dependency to be the newly created service instance (of typegithub
). -
Check the NodeCG logs:
You should see an error or a success message and a list of all your repositories.