github-0.14.0: Access to the Github API, v3.

Safe HaskellNone
LanguageHaskell2010

Github.GitData.References

Description

The underlying git references on a Github repo, exposed for the world to see. The git internals documentation will also prove handy for understanding these. API documentation at http://developer.github.com/v3/git/refs/.

Synopsis

Documentation

reference :: Name GithubOwner -> Name Repo -> Name GitReference -> IO (Either Error GitReference) Source

A single reference by the ref name.

reference "mike-burns" "github" "heads/master"

reference' :: Maybe GithubAuth -> Name GithubOwner -> Name Repo -> Name GitReference -> IO (Either Error GitReference) Source

A single reference by the ref name.

reference' (Just ("github-username", "github-password")) "mike-burns" "github" "heads/master"

references :: Name GithubOwner -> Name Repo -> IO (Either Error (Vector GitReference)) Source

The history of references for a repo.

references "mike-burns" "github"

references' :: Maybe GithubAuth -> Name GithubOwner -> Name Repo -> IO (Either Error (Vector GitReference)) Source

The history of references for a repo.

references "mike-burns" "github"

namespacedReferences :: Name GithubOwner -> Name Repo -> String -> IO (Either Error [GitReference]) Source

Limited references by a namespace.

namespacedReferences "thoughtbot" "paperclip" "tags"