System.Hapistrano.Types

Type definitions for the Hapistrano tool.

Documentation

type Hapistrano a = ExceptT Failure (ReaderT Config IO) a

Hapistrano monad.

data Failure

Failure with status code and a message.

Constructors

Failure Int (Maybe String)

data Config

Hapistrano configuration options.

Constructors

Config

Fields

• configSshOptions :: !(Maybe SshOptions)

  Nothing if we are running locally, or SSH options to use.

• configPrint :: !(OutputDest -> String -> IO ())

  How to print messages

data Task

The records describes deployment task.

Constructors

Task

Fields

• taskDeployPath :: Path Abs Dir

  The root of the deploy target on the remote host

• taskRepository :: String

  The URL of remote Git repo to deploy

• taskRevision :: String

  A SHA1 or branch to release

• taskReleaseFormat :: ReleaseFormat

  The ReleaseFormat to use

Instances

Eq Task

Defined in System.Hapistrano.Types

Methods

(==) :: Task -> Task -> Bool

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

Ord Task

Defined in System.Hapistrano.Types

Methods

compare :: Task -> Task -> Ordering

(<) :: Task -> Task -> Bool

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

(>) :: Task -> Task -> Bool

(>=) :: Task -> Task -> Bool

max :: Task -> Task -> Task

min :: Task -> Task -> Task

Show Task

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Task -> ShowS

show :: Task -> String

showList :: [Task] -> ShowS

data ReleaseFormat

Release format mode.

Constructors

ReleaseShort

Standard release path following Capistrano's format

ReleaseLong

Long release path including picoseconds

Instances

Bounded ReleaseFormat

Defined in System.Hapistrano.Types

Methods

minBound :: ReleaseFormat

maxBound :: ReleaseFormat

Enum ReleaseFormat

Defined in System.Hapistrano.Types

Methods

succ :: ReleaseFormat -> ReleaseFormat

pred :: ReleaseFormat -> ReleaseFormat

toEnum :: Int -> ReleaseFormat

fromEnum :: ReleaseFormat -> Int

enumFrom :: ReleaseFormat -> [ReleaseFormat]

enumFromThen :: ReleaseFormat -> ReleaseFormat -> [ReleaseFormat]

enumFromTo :: ReleaseFormat -> ReleaseFormat -> [ReleaseFormat]

enumFromThenTo :: ReleaseFormat -> ReleaseFormat -> ReleaseFormat -> [ReleaseFormat]

Eq ReleaseFormat

Defined in System.Hapistrano.Types

Methods

(==) :: ReleaseFormat -> ReleaseFormat -> Bool

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

Ord ReleaseFormat

Defined in System.Hapistrano.Types

Methods

compare :: ReleaseFormat -> ReleaseFormat -> Ordering

(<) :: ReleaseFormat -> ReleaseFormat -> Bool

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

(>) :: ReleaseFormat -> ReleaseFormat -> Bool

(>=) :: ReleaseFormat -> ReleaseFormat -> Bool

max :: ReleaseFormat -> ReleaseFormat -> ReleaseFormat

min :: ReleaseFormat -> ReleaseFormat -> ReleaseFormat

Read ReleaseFormat

Defined in System.Hapistrano.Types

Methods

readsPrec :: Int -> ReadS ReleaseFormat

readList :: ReadS [ReleaseFormat]

readPrec :: ReadPrec ReleaseFormat

readListPrec :: ReadPrec [ReleaseFormat]

Show ReleaseFormat

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> ReleaseFormat -> ShowS

show :: ReleaseFormat -> String

showList :: [ReleaseFormat] -> ShowS

data SshOptions

SSH options.

Constructors

SshOptions

Fields

• sshHost :: String

  Host to use

• sshPort :: Word

  Port to use

Instances

Eq SshOptions

Defined in System.Hapistrano.Types

Methods

(==) :: SshOptions -> SshOptions -> Bool

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

Ord SshOptions

Defined in System.Hapistrano.Types

Methods

compare :: SshOptions -> SshOptions -> Ordering

(<) :: SshOptions -> SshOptions -> Bool

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

(>) :: SshOptions -> SshOptions -> Bool

(>=) :: SshOptions -> SshOptions -> Bool

max :: SshOptions -> SshOptions -> SshOptions

min :: SshOptions -> SshOptions -> SshOptions

Read SshOptions

Defined in System.Hapistrano.Types

Methods

readsPrec :: Int -> ReadS SshOptions

readList :: ReadS [SshOptions]

readPrec :: ReadPrec SshOptions

readListPrec :: ReadPrec [SshOptions]

Show SshOptions

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> SshOptions -> ShowS

show :: SshOptions -> String

showList :: [SshOptions] -> ShowS

data OutputDest

Output destination.

Constructors

StdoutDest

StderrDest

Instances

Bounded OutputDest

Defined in System.Hapistrano.Types

Methods

minBound :: OutputDest

maxBound :: OutputDest

Enum OutputDest

Defined in System.Hapistrano.Types

Methods

succ :: OutputDest -> OutputDest

pred :: OutputDest -> OutputDest

toEnum :: Int -> OutputDest

fromEnum :: OutputDest -> Int

enumFrom :: OutputDest -> [OutputDest]

enumFromThen :: OutputDest -> OutputDest -> [OutputDest]

enumFromTo :: OutputDest -> OutputDest -> [OutputDest]

enumFromThenTo :: OutputDest -> OutputDest -> OutputDest -> [OutputDest]

Eq OutputDest

Defined in System.Hapistrano.Types

Methods

(==) :: OutputDest -> OutputDest -> Bool

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

Ord OutputDest

Defined in System.Hapistrano.Types

Methods

compare :: OutputDest -> OutputDest -> Ordering

(<) :: OutputDest -> OutputDest -> Bool

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

(>) :: OutputDest -> OutputDest -> Bool

(>=) :: OutputDest -> OutputDest -> Bool

max :: OutputDest -> OutputDest -> OutputDest

min :: OutputDest -> OutputDest -> OutputDest

Read OutputDest

Defined in System.Hapistrano.Types

Methods

readsPrec :: Int -> ReadS OutputDest

readList :: ReadS [OutputDest]

readPrec :: ReadPrec OutputDest

readListPrec :: ReadPrec [OutputDest]

Show OutputDest

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> OutputDest -> ShowS

show :: OutputDest -> String

showList :: [OutputDest] -> ShowS

data Release

Release indentifier.

Instances

Eq Release

Defined in System.Hapistrano.Types

Methods

(==) :: Release -> Release -> Bool

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

Ord Release

Defined in System.Hapistrano.Types

Methods

compare :: Release -> Release -> Ordering

(<) :: Release -> Release -> Bool

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

(>) :: Release -> Release -> Bool

(>=) :: Release -> Release -> Bool

max :: Release -> Release -> Release

min :: Release -> Release -> Release

Show Release

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Release -> ShowS

show :: Release -> String

showList :: [Release] -> ShowS

data TargetSystem

Target's system where application will be deployed

Constructors

GNULinux

BSD

Instances

Bounded TargetSystem

Defined in System.Hapistrano.Types

Methods

minBound :: TargetSystem

maxBound :: TargetSystem

Enum TargetSystem

Defined in System.Hapistrano.Types

Methods

succ :: TargetSystem -> TargetSystem

pred :: TargetSystem -> TargetSystem

toEnum :: Int -> TargetSystem

fromEnum :: TargetSystem -> Int

enumFrom :: TargetSystem -> [TargetSystem]

enumFromThen :: TargetSystem -> TargetSystem -> [TargetSystem]

enumFromTo :: TargetSystem -> TargetSystem -> [TargetSystem]

enumFromThenTo :: TargetSystem -> TargetSystem -> TargetSystem -> [TargetSystem]

Eq TargetSystem

Defined in System.Hapistrano.Types

Methods

(==) :: TargetSystem -> TargetSystem -> Bool

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

Ord TargetSystem

Defined in System.Hapistrano.Types

Methods

compare :: TargetSystem -> TargetSystem -> Ordering

(<) :: TargetSystem -> TargetSystem -> Bool

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

(>) :: TargetSystem -> TargetSystem -> Bool

(>=) :: TargetSystem -> TargetSystem -> Bool

max :: TargetSystem -> TargetSystem -> TargetSystem

min :: TargetSystem -> TargetSystem -> TargetSystem

Read TargetSystem

Defined in System.Hapistrano.Types

Methods

readsPrec :: Int -> ReadS TargetSystem

readList :: ReadS [TargetSystem]

readPrec :: ReadPrec TargetSystem

readListPrec :: ReadPrec [TargetSystem]

Show TargetSystem

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> TargetSystem -> ShowS

show :: TargetSystem -> String

showList :: [TargetSystem] -> ShowS

mkRelease :: ReleaseFormat -> UTCTime -> Release

Create a Release indentifier.

releaseTime :: Release -> UTCTime

Extract deployment time from Release.

renderRelease :: Release -> String

Render Release indentifier as a String.

parseRelease :: String -> Maybe Release

Parse Release identifier from a String.