Safe Haskell	Safe-Inferred
Language	GHC2021

Stack.Upload

Contents

Upload
Credentials
Internal

Description

Types and functions related to Stack's upload command.

Synopsis

data UploadOpts = UploadOpts {
- itemsToWorkWith :: ![String]
- documentation :: !Bool
- pvpBounds :: !(Maybe PvpBounds)
- check :: !Bool
- buildPackage :: !Bool
- tarPath :: !(Maybe FilePath)
- uploadVariant :: !UploadVariant
}
data SDistOpts = SDistOpts {
- dirsToWorkWith :: [String]
- pvpBounds :: Maybe PvpBounds
- ignoreCheck :: Bool
- buildTarball :: Bool
- tarPath :: Maybe FilePath
}
data UploadContent
- = SDist
- | DocArchive
data UploadVariant
- = Publishing
- | Candidate
uploadCmd :: UploadOpts -> RIO Runner ()
upload :: (HasLogFunc m, HasTerm m) => String -> HackageAuth -> UploadContent -> Maybe String -> FilePath -> UploadVariant -> RIO m ()
uploadBytes :: HasTerm m => String -> HackageAuth -> UploadContent -> Maybe String -> String -> UploadVariant -> ByteString -> RIO m ()
uploadRevision :: (HasLogFunc m, HasTerm m) => String -> HackageAuth -> PackageIdentifier -> ByteString -> RIO m ()
data HackageCreds
data HackageAuth
- = HAKey HackageKey
- | HACreds HackageCreds
newtype HackageKey = HackageKey Text
loadAuth :: (HasLogFunc m, HasTerm m) => Config -> RIO m HackageAuth
writeFilePrivate :: MonadIO m => FilePath -> Builder -> m ()
maybeGetHackageKey :: RIO m (Maybe HackageKey)

Upload

data UploadOpts Source #

Type representing command line options for the stack upload command.

Constructors

UploadOpts
Fields itemsToWorkWith :: ![String] The items to work with. documentation :: !Bool Uploading documentation for packages? pvpBounds :: !(Maybe PvpBounds) check :: !Bool buildPackage :: !Bool tarPath :: !(Maybe FilePath) uploadVariant :: !UploadVariant

data SDistOpts Source #

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

data UploadContent Source #

Type representing forms of content for upload to Hackage.

Constructors

SDist	Content in the form of an sdist tarball.
DocArchive	Content in the form of an archive file of package documentation.

data UploadVariant Source #

Type representing variants for uploading to Hackage.

Constructors

Publishing	Publish the package/a published package.
Candidate	Create a package candidate/a package candidate.

uploadCmd :: UploadOpts -> RIO Runner () Source #

Function underlying the stack upload command. Upload to Hackage.

upload Source #

Arguments

:: (HasLogFunc m, HasTerm m)
=> String	Hackage base URL
-> HackageAuth
-> UploadContent
-> Maybe String	Optional package identifier name, applies only to the upload of documentation.
-> FilePath	Path to archive file.
-> UploadVariant
-> RIO m ()

Upload a single tarball with the given Uploader.

Since 0.1.0.0

uploadBytes Source #

Arguments

:: HasTerm m
=> String	Hackage base URL
-> HackageAuth
-> UploadContent	Form of the content to be uploaded.
-> Maybe String	Optional package identifier name, applies only to the upload of documentation.
-> String	tar file name
-> UploadVariant
-> ByteString	tar file contents
-> RIO m ()

Upload a single tarball with the given Uploader. Instead of sending a file like upload, this sends a lazy bytestring.

Since 0.1.2.1

uploadRevision Source #

Arguments

:: (HasLogFunc m, HasTerm m)
=> String	Hackage base URL
-> HackageAuth
-> PackageIdentifier
-> ByteString
-> RIO m ()

Credentials

data HackageCreds Source #

Username and password to log into Hackage.

Since 0.1.0.0

Instances

Instances details

ToJSON HackageCreds Source #
Instance details Defined in Stack.Upload Methods toJSON :: HackageCreds -> Value # toEncoding :: HackageCreds -> Encoding # toJSONList :: [HackageCreds] -> Value # toEncodingList :: [HackageCreds] -> Encoding #
Show HackageCreds Source #
Instance details Defined in Stack.Upload Methods showsPrec :: Int -> HackageCreds -> ShowS # show :: HackageCreds -> String # showList :: [HackageCreds] -> ShowS #
Eq HackageCreds Source #
Instance details Defined in Stack.Upload Methods (==) :: HackageCreds -> HackageCreds -> Bool # (/=) :: HackageCreds -> HackageCreds -> Bool #
FromJSON (FilePath -> HackageCreds) Source #
Instance details Defined in Stack.Upload Methods parseJSON :: Value -> Parser (FilePath -> HackageCreds) # parseJSONList :: Value -> Parser [FilePath -> HackageCreds] #

data HackageAuth Source #

Constructors

HAKey HackageKey
HACreds HackageCreds

Instances

Instances details

Show HackageAuth Source #
Instance details Defined in Stack.Upload Methods showsPrec :: Int -> HackageAuth -> ShowS # show :: HackageAuth -> String # showList :: [HackageAuth] -> ShowS #
Eq HackageAuth Source #
Instance details Defined in Stack.Upload Methods (==) :: HackageAuth -> HackageAuth -> Bool # (/=) :: HackageAuth -> HackageAuth -> Bool #

newtype HackageKey Source #

Constructors

HackageKey Text

Instances

Instances details

Show HackageKey Source #
Instance details Defined in Stack.Upload Methods showsPrec :: Int -> HackageKey -> ShowS # show :: HackageKey -> String # showList :: [HackageKey] -> ShowS #
Eq HackageKey Source #
Instance details Defined in Stack.Upload Methods (==) :: HackageKey -> HackageKey -> Bool # (/=) :: HackageKey -> HackageKey -> Bool #

loadAuth :: (HasLogFunc m, HasTerm m) => Config -> RIO m HackageAuth Source #

writeFilePrivate :: MonadIO m => FilePath -> Builder -> m () Source #

Write contents to a file which is always private.

For history of this function, see:

Internal

maybeGetHackageKey :: RIO m (Maybe HackageKey) Source #