System.Hapistrano.Types

Type definitions for the Hapistrano tool.

Documentation

newtype Hapistrano a

Hapistrano monad.

Constructors

Hapistrano

Fields

• unHapistrano :: Config -> IO a

Instances

MonadIO Hapistrano

Defined in System.Hapistrano.Types

Methods

liftIO :: IO a -> Hapistrano a

Applicative Hapistrano

Defined in System.Hapistrano.Types

Methods

pure :: a -> Hapistrano a

(<*>) :: Hapistrano (a -> b) -> Hapistrano a -> Hapistrano b

liftA2 :: (a -> b -> c) -> Hapistrano a -> Hapistrano b -> Hapistrano c

(*>) :: Hapistrano a -> Hapistrano b -> Hapistrano b

(<*) :: Hapistrano a -> Hapistrano b -> Hapistrano a

Functor Hapistrano

Defined in System.Hapistrano.Types

Methods

fmap :: (a -> b) -> Hapistrano a -> Hapistrano b

(<$) :: a -> Hapistrano b -> Hapistrano a

Monad Hapistrano

Defined in System.Hapistrano.Types

Methods

(>>=) :: Hapistrano a -> (a -> Hapistrano b) -> Hapistrano b

(>>) :: Hapistrano a -> Hapistrano b -> Hapistrano b

return :: a -> Hapistrano a

MonadCatch Hapistrano

Defined in System.Hapistrano.Types

Methods

catch :: Exception e => Hapistrano a -> (e -> Hapistrano a) -> Hapistrano a

MonadThrow Hapistrano

Defined in System.Hapistrano.Types

Methods

throwM :: Exception e => e -> Hapistrano a

MonadReader Config Hapistrano

Defined in System.Hapistrano.Types

Methods

ask :: Hapistrano Config

local :: (Config -> Config) -> Hapistrano a -> Hapistrano a

reader :: (Config -> a) -> Hapistrano a

newtype HapistranoException

Hapistrano exception

Constructors

HapistranoException (Failure, Maybe Release)

Instances

Exception HapistranoException

Defined in System.Hapistrano.Types

Methods

toException :: HapistranoException -> SomeException

fromException :: SomeException -> Maybe HapistranoException

displayException :: HapistranoException -> String

Show HapistranoException

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> HapistranoException -> ShowS

show :: HapistranoException -> String

showList :: [HapistranoException] -> ShowS

data Failure

Failure with status code and a message.

Constructors

Failure Int (Maybe String)

Instances

Show Failure

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Failure -> ShowS

show :: Failure -> String

showList :: [Failure] -> ShowS

data Config

Hapistrano configuration options.

Constructors

Config

Fields

• configSshOptions :: !(Maybe SshOptions)

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

• configShellOptions :: !Shell

  One of the supported Shells

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

  How to print messages

Instances

MonadReader Config Hapistrano

Defined in System.Hapistrano.Types

Methods

ask :: Hapistrano Config

local :: (Config -> Config) -> Hapistrano a -> Hapistrano a

reader :: (Config -> a) -> Hapistrano a

data Source

The source of the repository. It can be from a version control provider like GitHub or a local directory.

Constructors

GitRepository

Fields

• gitRepositoryURL :: String

  The URL of remote Git repository to deploy

• gitRepositoryRevision :: String

  The SHA1 or branch to release

LocalDirectory

Fields

• localDirectoryPath :: Path Abs Dir

  The local repository to deploy

Instances

Show Source

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

Eq Source

Defined in System.Hapistrano.Types

Methods

(==) :: Source -> Source -> Bool

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

Ord Source

Defined in System.Hapistrano.Types

Methods

compare :: Source -> Source -> Ordering

(<) :: Source -> Source -> Bool

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

(>) :: Source -> Source -> Bool

(>=) :: Source -> Source -> Bool

max :: Source -> Source -> Source

min :: Source -> Source -> Source

data Task

The records describes deployment task.

Constructors

Task

Fields

• taskDeployPath :: Path Abs Dir

  The root of the deploy target on the remote host

• taskSource :: Source

  The Source to deploy

• taskReleaseFormat :: ReleaseFormat

  The ReleaseFormat to use

Instances

Show Task

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Task -> ShowS

show :: Task -> String

showList :: [Task] -> ShowS

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

data ReleaseFormat

Release format mode.

Constructors

ReleaseShort

Standard release path following Capistrano's format

ReleaseLong

Long release path including picoseconds

Instances

FromJSON ReleaseFormat

Defined in System.Hapistrano.Types

Methods

parseJSON :: Value -> Parser ReleaseFormat

parseJSONList :: Value -> Parser [ReleaseFormat]

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]

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

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

data SshOptions

SSH options.

Constructors

SshOptions

Fields

• sshHost :: String

  Host to use

• sshPort :: Word

  Port to use

• sshArgs :: [String]

  Arguments for ssh

Instances

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

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

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]

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

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

data Release

Release indentifier.

Instances

Show Release

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Release -> ShowS

show :: Release -> String

showList :: [Release] -> ShowS

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

data TargetSystem

Target's system where application will be deployed.

Constructors

GNULinux

BSD

Instances

FromJSON TargetSystem

Defined in System.Hapistrano.Config

Methods

parseJSON :: Value -> Parser TargetSystem

parseJSONList :: Value -> Parser [TargetSystem]

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]

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

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

data DeployState

State of the deployment after running hap deploy. note: the Unknown value is not intended to be written to the .hapistrano_deploy_state file; instead, it's intended to represent whenever Hapistrano couldn't get the information on the deployment state (e.g. the file is not present).

Constructors

Fail

Success

Unknown

Instances

Bounded DeployState

Defined in System.Hapistrano.Types

Methods

minBound :: DeployState

maxBound :: DeployState

Enum DeployState

Defined in System.Hapistrano.Types

Methods

succ :: DeployState -> DeployState

pred :: DeployState -> DeployState

toEnum :: Int -> DeployState

fromEnum :: DeployState -> Int

enumFrom :: DeployState -> [DeployState]

enumFromThen :: DeployState -> DeployState -> [DeployState]

enumFromTo :: DeployState -> DeployState -> [DeployState]

enumFromThenTo :: DeployState -> DeployState -> DeployState -> [DeployState]

Read DeployState

Defined in System.Hapistrano.Types

Methods

readsPrec :: Int -> ReadS DeployState

readList :: ReadS [DeployState]

readPrec :: ReadPrec DeployState

readListPrec :: ReadPrec [DeployState]

Show DeployState

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> DeployState -> ShowS

show :: DeployState -> String

showList :: [DeployState] -> ShowS

Eq DeployState

Defined in System.Hapistrano.Types

Methods

(==) :: DeployState -> DeployState -> Bool

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

Ord DeployState

Defined in System.Hapistrano.Types

Methods

compare :: DeployState -> DeployState -> Ordering

(<) :: DeployState -> DeployState -> Bool

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

(>) :: DeployState -> DeployState -> Bool

(>=) :: DeployState -> DeployState -> Bool

max :: DeployState -> DeployState -> DeployState

min :: DeployState -> DeployState -> DeployState

data Shell

Current shells supported.

Constructors

Bash

Zsh

Instances

FromJSON Shell

Defined in System.Hapistrano.Types

Methods

parseJSON :: Value -> Parser Shell

parseJSONList :: Value -> Parser [Shell]

Show Shell

Defined in System.Hapistrano.Types

Methods

showsPrec :: Int -> Shell -> ShowS

show :: Shell -> String

showList :: [Shell] -> ShowS

Eq Shell

Defined in System.Hapistrano.Types

Methods

(==) :: Shell -> Shell -> Bool

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

Ord Shell

Defined in System.Hapistrano.Types

Methods

compare :: Shell -> Shell -> Ordering

(<) :: Shell -> Shell -> Bool

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

(>) :: Shell -> Shell -> Bool

(>=) :: Shell -> Shell -> Bool

max :: Shell -> Shell -> Shell

min :: Shell -> Shell -> Shell

data Opts

Command line options.

Constructors

Opts

Fields

• optsCommand :: Command
• optsConfigFile :: FilePath

data Command

Command to execute and command-specific options.

Constructors

Deploy (Maybe ReleaseFormat) (Maybe Natural) Bool

Deploy a new release (with timestamp format, how many releases to keep, and whether the failed releases except the latest one get deleted or not)

Rollback Natural

Rollback to Nth previous release

Maintenance MaintenanceOptions

data MaintenanceOptions

Maintenance options

Constructors

Enable

Disable

Types helpers

mkRelease :: ReleaseFormat -> UTCTime -> Release

Create a Release indentifier.

releaseTime :: Release -> UTCTime

Extract deployment time from Release.

renderRelease :: Release -> String

Render Release indentifier as a Value.

parseRelease :: String -> Maybe Release

Parse Release identifier from a Value.

fromMaybeReleaseFormat :: Maybe ReleaseFormat -> Maybe ReleaseFormat -> ReleaseFormat

Get release format based on the CLI and file configuration values.

fromMaybeKeepReleases :: Maybe Natural -> Maybe Natural -> Natural

Get keep releases based on the CLI and file configuration values.

toMaybePath :: Source -> Maybe (Path Abs Dir)

Get the local path to copy from the Source configuration value.