Github.js provides a minimal higher-level wrapper around git's plumbing commands, exposing an API for manipulating GitHub repositories on the file level. It is being developed in the context of Prose, a content editor for GitHub.
Create a Github instance.
var github = new Github({
username: "YOU_USER",
password: "YOUR_PASSWORD",
auth: "basic"
});Or if you prefer OAuth, it looks like this:
var github = new Github({
token: "OAUTH_TOKEN"
auth: "oauth"
});var repo = github.getRepo(reponame);Retrieve all available branches (aka heads) of a repository.
repo.listBranches(function(err, branches) {
});Store contents at a certain path, where files that don't yet exist are created on the fly.
repo.write('master', 'path/to/file', 'YOUR_NEW_CONTENTS', 'YOUR_COMMIT_MESSAGE', function(err) {
});Not only can you can write files, you can of course read them.
repo.read('master', 'path/to/file', function(err, data) {
});Move a file from A to B.
repo.move('master', 'path/to/file', 'path/to/new_file', function(err) {
});Remove a file.
repo.remove('master', 'path/to/file', function(err) {
});Listing all files of a repository is easy too.
repo.list('master', 'path/to/file', function(err, data) {
});var user = github.getUser();List all repositories of the authenticated user.
user.repos(username, function(err, orgs) {
});List organizations the autenticated user belongs to.
user.orgs(function(err, orgs) {
});Show user information for a particular username. Also works for organizations.
user.show(username, function(err, user) {
});List public repositories for a particular user.
user.userRepos(username, function(err, repos) {
});List repositories for a particular organization. Includes private repositories if you are authorized.
user.orgRepos(orgname, function(err, repos) {
});Github.js is automatically™ tested by the users of Prose. Because of that, we decided to save some time by not maintaining a test suite. Yes, you heard right. :) However, you can still consider it stable since it is used in production.
##Setup
Github.js has the following dependencies:
- jQuery (for ajax)
- Underscore
- Base64 (for basic auth). You can leave this if you are not using basic auth.
Include these before github.js :
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js">
<script src="lib/underscore-min.js">
<script src="lib/base64.js">
<script src="github.js">
Adds support for organizations and fixes an encoding issue.
Smart caching of latest commit sha.
Added support for OAuth.
Support for Moving and removing files.
Consider commit messages.
Initial version.