github-0.23: Access to the GitHub API, v3.

LicenseBSD-3-Clause
MaintainerOleg Grenrus <oleg.grenrus@iki.fi>
Safe HaskellNone
LanguageHaskell2010

GitHub.Endpoints.Repos.Commits

Description

The repo commits API as described on http://developer.github.com/v3/repos/commits/.

Synopsis

Documentation

data CommitQueryOption Source #

The options for querying commits.

Instances
Eq CommitQueryOption Source # 
Instance details

Defined in GitHub.Data.GitData

Data CommitQueryOption Source # 
Instance details

Defined in GitHub.Data.GitData

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CommitQueryOption -> c CommitQueryOption #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CommitQueryOption #

toConstr :: CommitQueryOption -> Constr #

dataTypeOf :: CommitQueryOption -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CommitQueryOption) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CommitQueryOption) #

gmapT :: (forall b. Data b => b -> b) -> CommitQueryOption -> CommitQueryOption #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CommitQueryOption -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CommitQueryOption -> r #

gmapQ :: (forall d. Data d => d -> u) -> CommitQueryOption -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CommitQueryOption -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CommitQueryOption -> m CommitQueryOption #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CommitQueryOption -> m CommitQueryOption #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CommitQueryOption -> m CommitQueryOption #

Ord CommitQueryOption Source # 
Instance details

Defined in GitHub.Data.GitData

Show CommitQueryOption Source # 
Instance details

Defined in GitHub.Data.GitData

Generic CommitQueryOption Source # 
Instance details

Defined in GitHub.Data.GitData

Associated Types

type Rep CommitQueryOption :: Type -> Type #

type Rep CommitQueryOption Source # 
Instance details

Defined in GitHub.Data.GitData

commitsFor :: Name Owner -> Name Repo -> IO (Either Error (Vector Commit)) Source #

The commit history for a repo.

commitsFor "mike-burns" "github"

commitsFor' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error (Vector Commit)) Source #

The commit history for a repo. With authentication.

commitsFor' (Just $ BasicAuth "github-username" "github-password") "mike-burns" "github"

commitsWithOptionsFor' :: Maybe Auth -> Name Owner -> Name Repo -> [CommitQueryOption] -> IO (Either Error (Vector Commit)) Source #

The commit history for a repo, with commits filtered to satisfy a list of query options. With authentication.

commitsWithOptionsFor' (Just $ BasicAuth "github-username" "github-password") "mike-burns" "github" [CommitQueryAuthor "djeik"]

commit :: Name Owner -> Name Repo -> Name Commit -> IO (Either Error Commit) Source #

Details on a specific SHA1 for a repo.

commit "mike-burns" "github" "9d1a9a361266c3c890b1108ad2fdf52f824b1b81"

commit' :: Maybe Auth -> Name Owner -> Name Repo -> Name Commit -> IO (Either Error Commit) Source #

Details on a specific SHA1 for a repo. With authentication.

commit (Just $ BasicAuth "github-username" "github-password") "mike-burns" "github" "9d1a9a361266c3c890b1108ad2fdf52f824b1b81"

diff :: Name Owner -> Name Repo -> Name Commit -> Name Commit -> IO (Either Error Diff) Source #

The diff between two treeishes on a repo.

diff "thoughtbot" "paperclip" "41f685f6e01396936bb8cd98e7cca517e2c7d96b" "HEAD"

diff' :: Maybe Auth -> Name Owner -> Name Repo -> Name Commit -> Name Commit -> IO (Either Error Diff) Source #

The diff between two treeishes on a repo.

diff "thoughtbot" "paperclip" "41f685f6e01396936bb8cd98e7cca517e2c7d96b" "HEAD"