Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.86 KB

sdist_command.md

File metadata and controls

41 lines (30 loc) · 1.86 KB
Raw

The stack sdist command

stack sdist [DIR] [--pvp-bounds PVP-BOUNDS] [--ignore-check]
            [--[no-]test-tarball] [--tar-dir ARG]

Hackage only accepts packages for uploading in a standard form, a compressed archive ('tarball') in the format produced by Cabal's sdist action.

stack sdist generates a file for your package, in the format accepted by Hackage for uploads. The command will report the location of the generated file.

By default:

  • a file is generated for each project package. In the alternative, one or more project package directories can be specified;

  • the command will check the package for common mistakes. Pass the flag --ignore-check to disable the checks;

  • Stack will not test the generated file by attempting to build it. Pass the flag --test-tarball to cause Stack to test the generated file;

  • the generated file will be created in the dist directory of the project package directory. For information about the directory's location, command stack path --dist-dir. Pass the option ``--tar-dir <path_to_directory>` to also copy the file to the specified directory; and

  • no PVP version bounds are added to the Cabal file of the package. Pass the option --pvp-bounds <pvp_bounds_mode> to determine whether and, if so, how bounds should be added. The available modes for basic use are: none, lower, upper, and both. The available modes for use with Cabal file revisions are lower-revision, upper-revision and both-revision.

    For futher information, see the pvp-bounds non-project specific configuration option documentation.