| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Stackage.ServerBundle
Description
Create a bundle to be uploaded to Stackage Server.
- serverBundle :: EpochTime -> Text -> Text -> BuildPlan -> LByteString
- epochTime :: IO EpochTime
- bpAllPackages :: BuildPlan -> Map PackageName Version
- docsListing :: BuildPlan -> FilePath -> IO DocMap
- createBundleV2 :: CreateBundleV2 -> IO ()
- data CreateBundleV2 = CreateBundleV2 {
- cb2Plan :: BuildPlan
- cb2Type :: SnapshotType
- cb2DocsDir :: FilePath
- cb2Dest :: FilePath
- data SnapshotType
- writeIndexStyle :: Maybe Text -> FilePath -> IO [String]
- type DocMap = Map Text PackageDocs
- data PackageDocs = PackageDocs {}
Documentation
Arguments
| :: EpochTime | |
| -> Text | title |
| -> Text | slug |
| -> BuildPlan | |
| -> LByteString |
bpAllPackages :: BuildPlan -> Map PackageName Version Source
All package/versions in a build plan, including core packages.
Note that this may include packages not available on Hackage.
createBundleV2 :: CreateBundleV2 -> IO () Source
Create a V2 bundle, which contains the build plan, metadata, docs, and doc map.
data CreateBundleV2 Source
Constructors
| CreateBundleV2 | |
Fields
| |
data SnapshotType Source
Instances
| Eq SnapshotType | |
| Ord SnapshotType | |
| Read SnapshotType | |
| Show SnapshotType | |
| ToJSON SnapshotType | |
| FromJSON SnapshotType |
type DocMap = Map Text PackageDocs Source
Package name is key