Network.CircleCI.Project

API calls for work with info about projects.

API call

getProjectsInfo

Arguments

:: CircleCIResponse [ProjectInfo]

Info about projects.

Show info about all projects user is following. Based on https://circleci.com/docs/api/#projects.

Usage example:

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE LambdaCase #-}

import Network.CircleCI

main :: IO ()
main = runCircleCI getProjectsInfo
                   (AccountAPIToken "e64c674195bbc0d0be3efa2whatever")
    >>= \case
        Left problem -> print problem
        Right info   -> print info

Types for calls and response

data ProjectInfo

Info about single project.

Constructors

ProjectInfo

Fields

language :: Text

Programming language using in project.

repositoryName :: Text

repositoryUrl :: Text

Repository URL.

branches :: [BranchBuildInfo]

Info about recent builds in branches.

defaultBranch :: Text

Name of default branch.

isOpenSource :: Bool

If True - project is open.

followed :: Bool

If True - project is followed by some user.

gitHubUserName :: Text

GitHub user name. Slack

slackChannel :: Maybe Text

Slack channel name.

slackWebhookUrl :: Maybe Text

Slack webhook URL.

slackNotifyPreferenses :: Maybe Text

Slack notify preferences.

slackSubdomain :: Maybe Text

Slack subdomain.

slackAPIToken :: Maybe Text

Slack API token. HipChat

hipchatNotifyPreferenses :: Maybe Text

HipChat notify preferences.

hipchatNotify :: Maybe Text

HipChat notify.

hipchatAPIToken :: Maybe Text

HipChat API token.

hipchatRoom :: Maybe Text

HipChat room name. IRC

ircServer :: Maybe Text

IRC server.

ircKeyword :: Maybe Text

IRC keyword.

ircChannel :: Maybe Text

IRC channel name.

ircUsername :: Maybe Text

IRC user name.

ircPassword :: Maybe Text

IRC password.

ircNotifyPreferenses :: Maybe Text

IRC notify preferences.

Instances

Show ProjectInfo

FromJSON ProjectInfo

data BranchBuildInfo

Build info for a single branch.

Constructors

BranchBuildInfo

Fields

branchName :: Text

lastSuccessBuild :: Maybe BuildInfo

lastFailedBuild :: Maybe BuildInfo

pusherLogins :: [Text]

recentBuilds :: Maybe [BuildInfo]

runningBuilds :: Maybe [BuildInfo]

Instances

Eq BranchBuildInfo

Show BranchBuildInfo

data BuildInfo

Info about single build.

Constructors

BuildInfo

Fields

status :: BuildStatus

number :: Int

commit :: Text

pushDate :: UTCTime

addingDate :: UTCTime

Instances

Eq BuildInfo

Show BuildInfo

FromJSON BuildInfo

data BuildStatus

Build status.

Constructors

BuildRunning

BuildSuccess

BuildFailed

BuildCanceled

NoTests

Instances

Eq BuildStatus

Show BuildStatus

module Network.CircleCI.Common.Types

module Network.CircleCI.Common.Run