Stackage.BuildConstraints

The constraints on package selection for a new build plan.

Documentation

data BuildConstraints

Constructors

BuildConstraints

Fields

• bcPackages :: Set PackageName

  This does not include core packages.

• bcPackageConstraints :: PackageName -> PackageConstraints
• bcSystemInfo :: SystemInfo
• bcGithubUsers :: Map Text (Set Text)

  map an account to set of pingees

• bcBuildToolOverrides :: Map Text (Set Text)

  map a build tool name to a set of packages we should include

  Used to avoid situations like extra packages on Hackage providing the cabal executable

• bcTellMeWhenItsReleased :: Map PackageName Version
• bcNoRevisions :: !(Set PackageName)

  see cfNoRevisions

• bcCabalFormatVersion :: !(Maybe Version)

  Maximum supported Cabal file format version

data PackageConstraints

Constructors

PackageConstraints

Fields

• pcVersionRange :: VersionRange
• pcMaintainer :: Maybe Maintainer
• pcTests :: TestState
• pcBenches :: TestState
• pcHaddocks :: TestState
• pcFlagOverrides :: Map FlagName Bool
• pcConfigureArgs :: Vector Text
• pcEnableLibProfile :: Bool
• pcSkipBuild :: Bool

  Don't even bother building this library, useful when dealing with OS-specific packages. See: https://github.com/fpco/stackage-curator/issues/3

• pcHide :: !Bool

  Hide this package after registering, useful for avoiding module name conflicts

Instances

Eq PackageConstraints

Methods

(==) :: PackageConstraints -> PackageConstraints -> Bool

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

Show PackageConstraints

Methods

showsPrec :: Int -> PackageConstraints -> ShowS

show :: PackageConstraints -> String

showList :: [PackageConstraints] -> ShowS

ToJSON PackageConstraints

Methods

toJSON :: PackageConstraints -> Value

toEncoding :: PackageConstraints -> Encoding

toJSONList :: [PackageConstraints] -> Value

toEncodingList :: [PackageConstraints] -> Encoding

FromJSON PackageConstraints

Methods

parseJSON :: Value -> Parser PackageConstraints

parseJSONList :: Value -> Parser [PackageConstraints]

data TestState

Constructors

ExpectSuccess

ExpectFailure

Don'tBuild

when the test suite will pull in things we don't want

Instances

Bounded TestState

Methods

minBound :: TestState

maxBound :: TestState

Enum TestState

Methods

succ :: TestState -> TestState

pred :: TestState -> TestState

toEnum :: Int -> TestState

fromEnum :: TestState -> Int

enumFrom :: TestState -> [TestState]

enumFromThen :: TestState -> TestState -> [TestState]

enumFromTo :: TestState -> TestState -> [TestState]

enumFromThenTo :: TestState -> TestState -> TestState -> [TestState]

Eq TestState

Methods

(==) :: TestState -> TestState -> Bool

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

Ord TestState

Methods

compare :: TestState -> TestState -> Ordering

(<) :: TestState -> TestState -> Bool

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

(>) :: TestState -> TestState -> Bool

(>=) :: TestState -> TestState -> Bool

max :: TestState -> TestState -> TestState

min :: TestState -> TestState -> TestState

Show TestState

Methods

showsPrec :: Int -> TestState -> ShowS

show :: TestState -> String

showList :: [TestState] -> ShowS

ToJSON TestState

Methods

toJSON :: TestState -> Value

toEncoding :: TestState -> Encoding

toJSONList :: [TestState] -> Value

toEncodingList :: [TestState] -> Encoding

FromJSON TestState

Methods

parseJSON :: Value -> Parser TestState

parseJSONList :: Value -> Parser [TestState]

data SystemInfo

Constructors

SystemInfo

Fields

• siGhcVersion :: Version
• siOS :: OS
• siArch :: Arch
• siCorePackages :: Map PackageName Version
• siCoreExecutables :: Set ExeName

Instances

Eq SystemInfo

Methods

(==) :: SystemInfo -> SystemInfo -> Bool

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

Ord SystemInfo

Methods

compare :: SystemInfo -> SystemInfo -> Ordering

(<) :: SystemInfo -> SystemInfo -> Bool

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

(>) :: SystemInfo -> SystemInfo -> Bool

(>=) :: SystemInfo -> SystemInfo -> Bool

max :: SystemInfo -> SystemInfo -> SystemInfo

min :: SystemInfo -> SystemInfo -> SystemInfo

Show SystemInfo

Methods

showsPrec :: Int -> SystemInfo -> ShowS

show :: SystemInfo -> String

showList :: [SystemInfo] -> ShowS

ToJSON SystemInfo

Methods

toJSON :: SystemInfo -> Value

toEncoding :: SystemInfo -> Encoding

toJSONList :: [SystemInfo] -> Value

toEncodingList :: [SystemInfo] -> Encoding

FromJSON SystemInfo

Methods

parseJSON :: Value -> Parser SystemInfo

parseJSONList :: Value -> Parser [SystemInfo]

getSystemInfo :: IO SystemInfo

defaultBuildConstraints :: Manager -> IO BuildConstraints

The proposed plan from the requirements provided by contributors.

Checks the current directory for a build-constraints.yaml file and uses it if present. If not, downloads from Github.

toBC :: ConstraintFile -> IO BuildConstraints

data BuildConstraintsSource

Constructors

BCSDefault

BCSFile FilePath

BCSWeb Request

Instances

Show BuildConstraintsSource

Methods

showsPrec :: Int -> BuildConstraintsSource -> ShowS

show :: BuildConstraintsSource -> String

showList :: [BuildConstraintsSource] -> ShowS

loadBuildConstraints :: BuildConstraintsSource -> Manager -> IO BuildConstraints

setConstraints :: [Dependency] -> BuildConstraints -> BuildConstraints

Modify the version bounds with the given Dependencies