Checkmate.Publisher.GitHub

Documentation

data Error

Errors have been tagged according to their source, so you can more easily dispatch and handle them.

Constructors

HTTPError !HttpException

A HTTP error occurred. The actual caught error is included.

ParseError !Text

An error in the parser itself.

JsonError !Text

The JSON is malformed or unexpected.

UserError !Text

Incorrect input.

Instances

Show Error

Defined in GitHub.Data.Definitions

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Exception Error

Defined in GitHub.Data.Definitions

Methods

toException :: Error -> SomeException

fromException :: SomeException -> Maybe Error

displayException :: Error -> String

type OwnerName = Name Owner

type PullRequestId = Id PullRequest

type RepoName = Name Repo

type Token = ByteString

newtype URL

Data representing URLs in responses.

N.B. syntactical validity is not verified.

Constructors

URL Text

Instances

Eq URL

Defined in GitHub.Data.URL

Methods

(==) :: URL -> URL -> Bool

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

Data URL

Defined in GitHub.Data.URL

Methods

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

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

toConstr :: URL -> Constr

dataTypeOf :: URL -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> URL -> URL

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

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

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

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

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

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

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

Ord URL

Defined in GitHub.Data.URL

Methods

compare :: URL -> URL -> Ordering

(<) :: URL -> URL -> Bool

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

(>) :: URL -> URL -> Bool

(>=) :: URL -> URL -> Bool

max :: URL -> URL -> URL

min :: URL -> URL -> URL

Show URL

Defined in GitHub.Data.URL

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

Generic URL

Defined in GitHub.Data.URL

Associated Types

type Rep URL :: * -> *

Methods

from :: URL -> Rep URL x

to :: Rep URL x -> URL

ToJSON URL

Defined in GitHub.Data.URL

Methods

toJSON :: URL -> Value

toEncoding :: URL -> Encoding

toJSONList :: [URL] -> Value

toEncodingList :: [URL] -> Encoding

FromJSON URL

Defined in GitHub.Data.URL

Methods

parseJSON :: Value -> Parser URL

parseJSONList :: Value -> Parser [URL]

Binary URL

Defined in GitHub.Data.URL

Methods

put :: URL -> Put

get :: Get URL

putList :: [URL] -> Put

NFData URL

Defined in GitHub.Data.URL

Methods

rnf :: URL -> ()

type Rep URL

Defined in GitHub.Data.URL

type Rep URL = D1 (MetaData "URL" "GitHub.Data.URL" "github-0.19-GNcGYqsaYt4BqIyQ6QO61H" True) (C1 (MetaCons "URL" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

leaveComment :: Maybe OwnerName -> RepoName -> PullRequestId -> Token -> Maybe Text -> FilePath -> Checklist -> IO (Either Error (Maybe URL))

mkOwnerName :: Text -> OwnerName

mkPullRequestId :: Int -> PullRequestId

mkRepoName :: Text -> RepoName

pullRequestBaseSha :: Maybe OwnerName -> RepoName -> PullRequestId -> Token -> Maybe Text -> IO (Either Error Text)