Github.Repos

The Github Repos API, as documented at http://developer.github.com/v3/repos/

Querying repositories

userRepos :: String -> RepoPublicity -> IO (Either Error [Repo])

The repos for a user, by their login. Can be restricted to just repos they own, are a member of, or publicize. Private repos are currently not supported.

userRepos "mike-burns" All

userRepos' :: Maybe GithubAuth -> String -> RepoPublicity -> IO (Either Error [Repo])

The repos for a user, by their login. With authentication, but note that private repos are currently not supported.

userRepos' (Just (GithubBasicAuth (user, password))) "mike-burns" All

userRepo :: String -> String -> IO (Either Error Repo)

Details on a specific repo, given the owner and repo name.

userRepo "mike-burns" "github"

userRepo' :: Maybe GithubAuth -> String -> String -> IO (Either Error Repo)

Details on a specific repo, given the owner and repo name. With authentication.

userRepo' (Just (GithubBasicAuth (user, password))) "mike-burns" "github"

organizationRepos :: String -> IO (Either Error [Repo])

The repos for an organization, by the organization name.

organizationRepos "thoughtbot"

organizationRepos' :: Maybe GithubAuth -> String -> IO (Either Error [Repo])

The repos for an organization, by the organization name. With authentication.

organizationRepos (Just (GithubBasicAuth (user, password))) "thoughtbot"

organizationRepo :: String -> String -> IO (Either Error Repo)

A specific organization repo, by the organization name.

organizationRepo "thoughtbot" "github"

organizationRepo' :: Maybe GithubAuth -> String -> String -> IO (Either Error Repo)

A specific organization repo, by the organization name. With authentication.

organizationRepo (Just (GithubBasicAuth (user, password))) "thoughtbot" "github"

contributors :: String -> String -> IO (Either Error [Contributor])

The contributors to a repo, given the owner and repo name.

contributors "thoughtbot" "paperclip"

contributors' :: Maybe GithubAuth -> String -> String -> IO (Either Error [Contributor])

The contributors to a repo, given the owner and repo name. With authentication.

contributors' (Just (GithubBasicAuth (user, password))) "thoughtbot" "paperclip"

contributorsWithAnonymous :: String -> String -> IO (Either Error [Contributor])

The contributors to a repo, including anonymous contributors (such as deleted users or git commits with unknown email addresses), given the owner and repo name.

contributorsWithAnonymous "thoughtbot" "paperclip"

contributorsWithAnonymous' :: Maybe GithubAuth -> String -> String -> IO (Either Error [Contributor])

The contributors to a repo, including anonymous contributors (such as deleted users or git commits with unknown email addresses), given the owner and repo name. With authentication.

contributorsWithAnonymous' (Just (GithubBasicAuth (user, password))) "thoughtbot" "paperclip"

languagesFor :: String -> String -> IO (Either Error [Language])

The programming languages used in a repo along with the number of characters written in that language. Takes the repo owner and name.

languagesFor "mike-burns" "ohlaunch"

languagesFor' :: Maybe GithubAuth -> String -> String -> IO (Either Error [Language])

The programming languages used in a repo along with the number of characters written in that language. Takes the repo owner and name. With authentication.

languagesFor' (Just (GithubBasicAuth (user, password))) "mike-burns" "ohlaunch"

tagsFor :: String -> String -> IO (Either Error [Tag])

The git tags on a repo, given the repo owner and name.

tagsFor "thoughtbot" "paperclip"

tagsFor' :: Maybe GithubAuth -> String -> String -> IO (Either Error [Tag])

The git tags on a repo, given the repo owner and name. With authentication.

tagsFor' (Just (GithubBasicAuth (user, password))) "thoughtbot" "paperclip"

branchesFor :: String -> String -> IO (Either Error [Branch])

The git branches on a repo, given the repo owner and name.

branchesFor "thoughtbot" "paperclip"

branchesFor' :: Maybe GithubAuth -> String -> String -> IO (Either Error [Branch])

The git branches on a repo, given the repo owner and name. With authentication.

branchesFor' (Just (GithubBasicAuth (user, password))) "thoughtbot" "paperclip"

contentsFor :: String -> String -> String -> Maybe String -> IO (Either Error Content)

The contents of a file or directory in a repo, given the repo owner, name, and path to the file

contentsFor "thoughtbot" "paperclip" "README.md"

contentsFor' :: Maybe GithubAuth -> String -> String -> String -> Maybe String -> IO (Either Error Content)

The contents of a file or directory in a repo, given the repo owner, name, and path to the file With Authentication

contentsFor' (Just (GithubBasicAuth (user, password))) "thoughtbot" "paperclip" "README.md"

module Github.Data

data RepoPublicity

Filter the list of the user's repos using any of these constructors.

Constructors

All

All repos accessible to the user.

Owner

Only repos owned by the user.

Public

Only public repos.

Private

Only private repos.

Member

Only repos to which the user is a member but not an owner.

Instances

Eq RepoPublicity

Show RepoPublicity

Create

createRepo :: GithubAuth -> NewRepo -> IO (Either Error Repo)

Create a new repository.

createRepo (GithubBasicAuth (user, password)) (newRepo "some_repo") {newRepoHasIssues = Just False}

createOrganizationRepo :: GithubAuth -> String -> NewRepo -> IO (Either Error Repo)

Create a new repository for an organization.

createOrganizationRepo (GithubBasicAuth (user, password)) "thoughtbot" (newRepo "some_repo") {newRepoHasIssues = Just False}

newRepo :: String -> NewRepo

data NewRepo

Constructors

NewRepo

Fields

newRepoName :: String

newRepoDescription :: Maybe String

newRepoHomepage :: Maybe String

newRepoPrivate :: Maybe Bool

newRepoHasIssues :: Maybe Bool

newRepoHasWiki :: Maybe Bool

newRepoAutoInit :: Maybe Bool

Instances

Show NewRepo

ToJSON NewRepo

Edit

editRepo

Arguments

:: GithubAuth

-> String

owner

-> String

repository name

-> Edit

-> IO (Either Error Repo)

Edit an existing repository.

editRepo (GithubBasicAuth (user, password)) "some_user" "some_repo" def {editDescription = Just "some description"}

def :: Default a => a

The default value for this type.

data Edit

Constructors

Edit

Fields

editName :: Maybe String

editDescription :: Maybe String

editHomepage :: Maybe String

editPublic :: Maybe Bool

editHasIssues :: Maybe Bool

editHasWiki :: Maybe Bool

editHasDownloads :: Maybe Bool

Instances

Show Edit

ToJSON Edit

Default Edit

Delete

deleteRepo

Arguments

:: GithubAuth

-> String

owner

-> String

repository name

-> IO (Either Error ())

Delete an existing repository.

deleteRepo (GithubBasicAuth (user, password)) "thoughtbot" "some_repo"