Copyright	© 2015-Present Stack Builders
License	MIT
Maintainer	Juan Paucar <jpaucar@stackbuilders.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

System.Hapistrano.Types

Contents

Types helpers

Description

Type definitions for the Hapistrano tool.

Synopsis

type Hapistrano a = ExceptT Failure (ReaderT Config IO) a
data Failure = Failure Int (Maybe String)
data Config = Config {
- configSshOptions :: !(Maybe SshOptions)
- configShellOptions :: !Shell
- configPrint :: !(OutputDest -> String -> IO ())
}
data Source
- = GitRepository {
  - gitRepositoryURL :: String
  - gitRepositoryRevision :: String
  }
- | LocalDirectory {
  - localDirectoryPath :: Path Abs Dir
  }
data Task = Task {
- taskDeployPath :: Path Abs Dir
- taskSource :: Source
- taskReleaseFormat :: ReleaseFormat
}
data ReleaseFormat
- = ReleaseShort
- | ReleaseLong
data SshOptions = SshOptions {
- sshHost :: String
- sshPort :: Word
- sshArgs :: [String]
}
data OutputDest
- = StdoutDest
- | StderrDest
data Release
data TargetSystem
- = GNULinux
- | BSD
data Shell
- = Bash
- | Zsh
mkRelease :: ReleaseFormat -> UTCTime -> Release
releaseTime :: Release -> UTCTime
renderRelease :: Release -> String
parseRelease :: String -> Maybe Release
fromMaybeReleaseFormat :: Maybe ReleaseFormat -> Maybe ReleaseFormat -> ReleaseFormat
fromMaybeKeepReleases :: Maybe Natural -> Maybe Natural -> Natural
toMaybePath :: Source -> Maybe (Path Abs Dir)

Documentation

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

Hapistrano monad.

data Failure Source #

Failure with status code and a message.

Constructors

Failure Int (Maybe String)

data Config Source #

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 `Shell`s configPrint :: !(OutputDest -> String -> IO ()) How to print messages

data Source 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

Instances details

Eq Source Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: Source -> Source -> Bool # (/=) :: Source -> Source -> Bool #
Ord Source Source #
Instance details 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 #
Show Source Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> Source -> ShowS # show :: Source -> String # showList :: [Source] -> ShowS #

data Task Source #

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

Instances details

Eq Task Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: Task -> Task -> Bool # (/=) :: Task -> Task -> Bool #
Ord Task Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> Task -> ShowS # show :: Task -> String # showList :: [Task] -> ShowS #

data ReleaseFormat Source #

Release format mode.

Constructors

ReleaseShort	Standard release path following Capistrano's format
ReleaseLong	Long release path including picoseconds

Instances

Instances details

Bounded ReleaseFormat Source #
Instance details Defined in System.Hapistrano.Types Methods minBound :: ReleaseFormat # maxBound :: ReleaseFormat #
Enum ReleaseFormat Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: ReleaseFormat -> ReleaseFormat -> Bool # (/=) :: ReleaseFormat -> ReleaseFormat -> Bool #
Ord ReleaseFormat Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods readsPrec :: Int -> ReadS ReleaseFormat # readList :: ReadS [ReleaseFormat] # readPrec :: ReadPrec ReleaseFormat # readListPrec :: ReadPrec [ReleaseFormat] #
Show ReleaseFormat Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> ReleaseFormat -> ShowS # show :: ReleaseFormat -> String # showList :: [ReleaseFormat] -> ShowS #
FromJSON ReleaseFormat Source #
Instance details Defined in System.Hapistrano.Types Methods parseJSON :: Value -> Parser ReleaseFormat # parseJSONList :: Value -> Parser [ReleaseFormat] #

data SshOptions Source #

SSH options.

Constructors

SshOptions
Fields sshHost :: String Host to use sshPort :: Word Port to use sshArgs :: [String] Arguments for ssh

Instances

Instances details

Eq SshOptions Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: SshOptions -> SshOptions -> Bool # (/=) :: SshOptions -> SshOptions -> Bool #
Ord SshOptions Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods readsPrec :: Int -> ReadS SshOptions # readList :: ReadS [SshOptions] # readPrec :: ReadPrec SshOptions # readListPrec :: ReadPrec [SshOptions] #
Show SshOptions Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> SshOptions -> ShowS # show :: SshOptions -> String # showList :: [SshOptions] -> ShowS #

data OutputDest Source #

Output destination.

Constructors

StdoutDest
StderrDest

Instances

Instances details

Bounded OutputDest Source #
Instance details Defined in System.Hapistrano.Types Methods minBound :: OutputDest # maxBound :: OutputDest #
Enum OutputDest Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: OutputDest -> OutputDest -> Bool # (/=) :: OutputDest -> OutputDest -> Bool #
Ord OutputDest Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods readsPrec :: Int -> ReadS OutputDest # readList :: ReadS [OutputDest] # readPrec :: ReadPrec OutputDest # readListPrec :: ReadPrec [OutputDest] #
Show OutputDest Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> OutputDest -> ShowS # show :: OutputDest -> String # showList :: [OutputDest] -> ShowS #

data Release Source #

Release indentifier.

Instances

Instances details

Eq Release Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: Release -> Release -> Bool # (/=) :: Release -> Release -> Bool #
Ord Release Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> Release -> ShowS # show :: Release -> String # showList :: [Release] -> ShowS #

data TargetSystem Source #

Target's system where application will be deployed

Constructors

GNULinux
BSD

Instances

Instances details

Bounded TargetSystem Source #
Instance details Defined in System.Hapistrano.Types Methods minBound :: TargetSystem # maxBound :: TargetSystem #
Enum TargetSystem Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: TargetSystem -> TargetSystem -> Bool # (/=) :: TargetSystem -> TargetSystem -> Bool #
Ord TargetSystem Source #
Instance details 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 Source #
Instance details Defined in System.Hapistrano.Types Methods readsPrec :: Int -> ReadS TargetSystem # readList :: ReadS [TargetSystem] # readPrec :: ReadPrec TargetSystem # readListPrec :: ReadPrec [TargetSystem] #
Show TargetSystem Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> TargetSystem -> ShowS # show :: TargetSystem -> String # showList :: [TargetSystem] -> ShowS #
FromJSON TargetSystem Source #
Instance details Defined in System.Hapistrano.Config Methods parseJSON :: Value -> Parser TargetSystem # parseJSONList :: Value -> Parser [TargetSystem] #

data Shell Source #

Current shells supported.

Constructors

Bash
Zsh

Instances

Instances details

Eq Shell Source #
Instance details Defined in System.Hapistrano.Types Methods (==) :: Shell -> Shell -> Bool # (/=) :: Shell -> Shell -> Bool #
Ord Shell Source #
Instance details 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 #
Show Shell Source #
Instance details Defined in System.Hapistrano.Types Methods showsPrec :: Int -> Shell -> ShowS # show :: Shell -> String # showList :: [Shell] -> ShowS #
FromJSON Shell Source #
Instance details Defined in System.Hapistrano.Types Methods parseJSON :: Value -> Parser Shell # parseJSONList :: Value -> Parser [Shell] #

Types helpers

mkRelease :: ReleaseFormat -> UTCTime -> Release Source #

Create a Release indentifier.

releaseTime :: Release -> UTCTime Source #

Extract deployment time from Release.

renderRelease :: Release -> String Source #

Render Release indentifier as a String.

parseRelease :: String -> Maybe Release Source #

Parse Release identifier from a String.

fromMaybeReleaseFormat :: Maybe ReleaseFormat -> Maybe ReleaseFormat -> ReleaseFormat Source #

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

fromMaybeKeepReleases :: Maybe Natural -> Maybe Natural -> Natural Source #

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

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

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