Stack.SDist

Documentation

data SDistOpts

Type representing command line options for stack sdist command.

Constructors

SDistOpts

Fields

• dirsToWorkWith :: [String]

  Directories to package

• pvpBounds :: Maybe PvpBounds

  PVP Bounds overrides

• ignoreCheck :: Bool

  Whether to ignore check of the package for common errors

• buildTarball :: Bool

  Whether to build the tarball

• tarPath :: Maybe FilePath

  Where to copy the tarball

sdistCmd :: SDistOpts -> RIO Runner ()

Function underlying the stack sdist command.

getSDistTarball

Arguments

:: HasEnvConfig env

=> Maybe PvpBounds

Override Config value

-> Path Abs Dir

Path to local package

-> RIO env (FilePath, ByteString, Maybe (PackageIdentifier, ByteString))

Filename, tarball contents, and option Cabal file revision to upload

Given the path to a local package, creates its source distribution tarball.

While this yields a FilePath, the name of the tarball, this tarball is not written to the disk and instead yielded as a lazy bytestring.

checkSDistTarball

Arguments

:: HasEnvConfig env

=> SDistOpts

The configuration of what to check

-> Path Abs File

Absolute path to tarball

-> RIO env ()

Check package in given tarball. This will log all warnings and will throw an exception in case of critical errors.

Note that we temporarily decompress the archive to analyze it.

checkSDistTarball'

Arguments

:: HasEnvConfig env

=> SDistOpts

-> String

Tarball name

-> ByteString

Tarball contents as a byte string

-> RIO env ()

Version of checkSDistTarball that first saves lazy bytestring to temporary directory and then calls checkSDistTarball on it.

readLocalPackage :: HasEnvConfig env => Path Abs Dir -> RIO env LocalPackage

Read in a LocalPackage config. This makes some default decisions about LocalPackage fields that might not be appropriate for other use-cases.