Stackage.ServerBundle

Create a bundle to be uploaded to Stackage Server.

Documentation

serverBundle

Arguments

:: EpochTime

-> Text

title

-> Text

slug

-> BuildPlan

-> LByteString

epochTime :: IO EpochTime

Get current time

bpAllPackages :: BuildPlan -> Map PackageName Version

All package/versions in a build plan, including core packages.

Note that this may include packages not available on Hackage.

docsListing

Arguments

:: BuildPlan

-> FilePath

docs directory

-> IO DocMap

createBundleV2 :: CreateBundleV2 -> IO ()

Create a V2 bundle, which contains the build plan, metadata, docs, and doc map.

data CreateBundleV2

Constructors

CreateBundleV2

Fields

• cb2Plan :: BuildPlan
• cb2Type :: SnapshotType
• cb2DocsDir :: FilePath
• cb2Dest :: FilePath
• cb2DocmapFile :: !FilePath

data SnapshotType

Constructors

STNightly

STNightly2 !Day

STLTS !Int !Int

major, minor

Instances

Eq SnapshotType

Methods

(==) :: SnapshotType -> SnapshotType -> Bool

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

Ord SnapshotType

Methods

compare :: SnapshotType -> SnapshotType -> Ordering

(<) :: SnapshotType -> SnapshotType -> Bool

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

(>) :: SnapshotType -> SnapshotType -> Bool

(>=) :: SnapshotType -> SnapshotType -> Bool

max :: SnapshotType -> SnapshotType -> SnapshotType

min :: SnapshotType -> SnapshotType -> SnapshotType

Read SnapshotType

Methods

readsPrec :: Int -> ReadS SnapshotType

readList :: ReadS [SnapshotType]

readPrec :: ReadPrec SnapshotType

readListPrec :: ReadPrec [SnapshotType]

Show SnapshotType

Methods

showsPrec :: Int -> SnapshotType -> ShowS

show :: SnapshotType -> String

showList :: [SnapshotType] -> ShowS

ToJSON SnapshotType

Methods

toJSON :: SnapshotType -> Value

toEncoding :: SnapshotType -> Encoding

toJSONList :: [SnapshotType] -> Value

toEncodingList :: [SnapshotType] -> Encoding

FromJSON SnapshotType

Methods

parseJSON :: Value -> Parser SnapshotType

parseJSONList :: Value -> Parser [SnapshotType]

writeIndexStyle

Arguments

:: Maybe Text

snapshot id

-> FilePath

docs dir

-> IO [String]

type DocMap = Map Text PackageDocs

Package name is key

data PackageDocs

Constructors

PackageDocs

Fields

• pdVersion :: Text
• pdModules :: Map Text [Text]

  module name, path

Instances

ToJSON PackageDocs

Methods

toJSON :: PackageDocs -> Value

toEncoding :: PackageDocs -> Encoding

toJSONList :: [PackageDocs] -> Value

toEncodingList :: [PackageDocs] -> Encoding

FromJSON PackageDocs

Methods

parseJSON :: Value -> Parser PackageDocs

parseJSONList :: Value -> Parser [PackageDocs]