GitHub.Endpoints.Repos.Commits

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

Documentation

data CommitQueryOption

The options for querying commits.

Constructors

CommitQuerySha !Text

CommitQueryPath !Text

CommitQueryAuthor !Text

CommitQuerySince !UTCTime

CommitQueryUntil !UTCTime

Instances

Eq CommitQueryOption

Defined in GitHub.Data.GitData

Methods

(==) :: CommitQueryOption -> CommitQueryOption -> Bool

(/=) :: CommitQueryOption -> CommitQueryOption -> Bool

Data CommitQueryOption

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

Defined in GitHub.Data.GitData

Methods

compare :: CommitQueryOption -> CommitQueryOption -> Ordering

(<) :: CommitQueryOption -> CommitQueryOption -> Bool

(<=) :: CommitQueryOption -> CommitQueryOption -> Bool

(>) :: CommitQueryOption -> CommitQueryOption -> Bool

(>=) :: CommitQueryOption -> CommitQueryOption -> Bool

max :: CommitQueryOption -> CommitQueryOption -> CommitQueryOption

min :: CommitQueryOption -> CommitQueryOption -> CommitQueryOption

Show CommitQueryOption

Defined in GitHub.Data.GitData

Methods

showsPrec :: Int -> CommitQueryOption -> ShowS

show :: CommitQueryOption -> String

showList :: [CommitQueryOption] -> ShowS

Generic CommitQueryOption

Defined in GitHub.Data.GitData

Associated Types

type Rep CommitQueryOption :: Type -> Type

Methods

from :: CommitQueryOption -> Rep CommitQueryOption x

to :: Rep CommitQueryOption x -> CommitQueryOption

type Rep CommitQueryOption

Defined in GitHub.Data.GitData

type Rep CommitQueryOption = D1 (MetaData "CommitQueryOption" "GitHub.Data.GitData" "github-0.23-11dKNrzUdUsEui3iNni5w1" False) ((C1 (MetaCons "CommitQuerySha" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: C1 (MetaCons "CommitQueryPath" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :+: (C1 (MetaCons "CommitQueryAuthor" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: (C1 (MetaCons "CommitQuerySince" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UTCTime)) :+: C1 (MetaCons "CommitQueryUntil" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UTCTime)))))

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

The commit history for a repo.

commitsFor "mike-burns" "github"

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

The commit history for a repo. With authentication.

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

commitsForR :: Name Owner -> Name Repo -> FetchCount -> Request k (Vector Commit)

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commitsWithOptionsFor :: Name Owner -> Name Repo -> [CommitQueryOption] -> IO (Either Error (Vector Commit))

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

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"]

commitsWithOptionsForR :: Name Owner -> Name Repo -> FetchCount -> [CommitQueryOption] -> Request k (Vector Commit)

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

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

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)

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

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

commitR :: Name Owner -> Name Repo -> Name Commit -> Request k Commit

Query a single commit. See https://developer.github.com/v3/repos/commits/#get-a-single-commit

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

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)

The diff between two treeishes on a repo.

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

diffR :: Name Owner -> Name Repo -> Name Commit -> Name Commit -> Request k Diff

Compare two commits. See https://developer.github.com/v3/repos/commits/#compare-two-commits

module GitHub.Data