rc/v2.13.0.1 (release candidate)

Release notes:

• Further to the release notes for Stack 2.3.1, the -static suffix has been removed from the statically linked Linux/x86_64 binaries.
• The binaries for Linux/Aarch64 are now statically linked.
• The release now includes binaries for macOS/AArch64.

Changes since v2.11.1:

Behavior changes:

• Build artefacts are placed in .stack-work/dist/<platform>/<GHC_version> (hashed to a shorter path on Windows), rather than .stack-work/dist/<platform>/<Cabal_version>. This allows build artifacts to be distinguished by GHC version.
• By default, the stack build progress bar is capped to a length equal to the terminal width.
• When building GHC from source, Stack no longer uses Hadrian's deprecated --configure\-c flag and, instead, seeks to run GHC's Python boot and sh configure scripts, and ensure that the happy and alex executables are on the PATH.
• When auto-detecting --ghc-build on Linux, the musl GHC build only is considered a possible GHC build if libc.musl-x86_64.so.1 is found in \lib or \lib64.
• No longer supports Cabal versions older than 1.24.0.0. This means projects using snapshots earlier than lts-7.0 or nightly-2016-05-26 will no longer build.
• When unregistering many packages in a single step, Stack can now do that efficiently. Stack no longer uses GHC-supplied ghc-pkg unregister (which is, currently, slower).

Other enhancements:

• Bump to Hpack 0.35.5.
• Depend on pantry-0.9.2, for support for long filenames and directory names in archives created by git archive.
• Avoid the duplicate resolving of usage files when parsing *.hi files into a set of modules and a collection of resolved usage files. See #6123.
• Add composable component type flags --exes, --tests and --benchmarks to Stack's ide targets command, to list only those components.
• stack --verbose excludes lengthy information about build plan construction in the debug output by default. The new stack --[no-]plan-in-log flag enables or disables the inclusion of the information in the debug output.
• In YAML configuration files, the casa key is introduced, which takes precedence over the existing casa-repo-prefix key. The latter is deprecated. The new key also allows Stack's use of a Casa (content-addressable storage archive) server to be disabled and the maximum number of keys per request to be configured. The defaults are unchanged.
• Add option --progress-bar=<format> to Stack's build command to configure the format of the progress bar, where <format> is one of none, count-only (only the package count), capped (capped to a length equal to the terminal width) and full (the previous format).

Bug fixes:

• Restore stack sdist --pvp-bounds lower (broken with Stack 2.9.1).
• Restore building of Stack with Cabal flag disable-git-info (broken with Stack 2.11.1).
• With stack hoogle, avoid the message Minimum version is hoogle-5.0. Found acceptable hoogle-<x.y.z> in your index, requiring its installation. when a hoogle executable has already been found on the PATH.
• Stack's sanity check on a selected GHC now passes GHC flag -hide-all-packages, stopping GHC from looking for a package environment in default locations.
• Restore Stack script files without extensions (broken with Stack 2.11.1).

v2.11.1

See https://haskellstack.org/ for installation and upgrade instructions.

Changes since v2.9.3:

Behavior changes:

• Add flag --[no-]-only-local-bin to Stack's upgrade command for a binary upgrade. If the Stack executable is my-stack, the default is my-stack upgrade --only-local-bin where previously it was, effectively, my-stack upgrade --no-only-local-bin. If the Stack executable is stack, the default is stack upgrade --no-only-local-bin, the same behaviour as previously.
• Use $XDG_CACHE_HOME/stack/ghci-script, rather than <temp>/haskell-stack-ghci (where <temp> is the directory yielded by the temporary package's System.IO.Temp.getCanonicalTemporaryDirectory), as the base location for GHCi script files generated by stack ghci or stack repl. See #5203
• Drop support for Cabal versions before 1.22 and, consequently, GHC versions before 7.10.
• stack ghci and stack repl now take into account the values of default-language keys in Cabal files, like they take into account the values of default-extensions keys.
• Removed --ghc-paths, --global-stack-root and --local-bin-path flags for stack path, deprecated in Stack 1.1.0 in favour of --programs, --stack-root and local-bin respectively.
• On Windows, stack upgrade always renames the file of the running Stack executable (adding extension .old) before attempting to write to the original file name.
• On Windows, stack upgrade does not offer sudo command alternatives if attempting to write to the original file name of the running Stack exectuable results in a 'Permission' error.

Other enhancements:

• Add options of the form --PROG-option=<argument> to stack build, where PROG is a program recognised by the Cabal library and one of alex, ar, c2hs, cpphs, gcc, greencard, happy, hsc2hs, hscolour, ld, pkg-config, strip and tar. If Cabal uses the program during the configuration step, the argument is passed to it.
• By default all --PROG-option options are applied to all local packages. This behaviour can be changed with new configuration option apply-prog-options.
• Add flag --[no-]use-root to stack script (default disabled). Used with --compile or --optimize, when enabled all compilation outputs (including the executable) are written to a script-specific location in the scripts directory of the Stack root rather than the script's directory, avoiding clutter of the latter directory.
• Better error message if the value of the STACK_WORK environment variable or --work-dir option is not a valid relative path.
• Stack will use the value of the GH_TOKEN, or GITHUB_TOKEN, environment variable as credentials to authenticate its GitHub REST API requests.
• stack uninstall also shows how to uninstall Stack-supplied tools.

Bug fixes:

• Fix incorrect warning if allow-newer-deps are specified but allow-newer is false. See #6068.
• stack build with --file-watch or --file-watch-poll outputs 'pretty' error messages, as intended. See #5978.
• stack build unregisters any local packages for the sub libraries of a local package that is to be unregistered. See #6046.
• The warning that sublibrary dependency is not supported is no longer triggered by internal libraries.

Thanks to all our contributors for this release:

• Chris Wendt
• Illia Bobyr
• Jens Petersen
• Max Taldykin
• MaxHearnden
• Mike Pilgrem
• Phil de Joux
• theophilebatoz

rc/v2.11.0.1 (release candidate)

Changes since v2.9.3:

Behavior changes:

• Drop support for Cabal versions before 1.22 and, consequently, GHC versions before 7.10.
• stack ghci and stack repl now take into account the values of default-language keys in Cabal files, like they take into account the values of default-extensions keys.
• Removed --ghc-paths, --global-stack-root and --local-bin-path flags for stack path, deprecated in Stack 1.1.0 in favour of --programs, --stack-root and local-bin respectively.
• On Windows, stack upgrade always renames the file of the running Stack executable (adding extension .old) before attempting to write to the original file name.
• On Windows, stack upgrade does not offer sudo command alternatives if attempting to write to the original file name of the running Stack exectuable results in a 'Permission' error.

Other enhancements:

• Add options of the form --PROG-option=<argument> to stack build, where PROG is a program recognised by the Cabal library and one of alex, ar, c2hs, cpphs, gcc, greencard, happy, hsc2hs, hscolour, ld, pkg-config, strip and tar. If Cabal uses the program during the configuration step, the argument is passed to it.
• By default all --PROG-option options are applied to all local packages. This behaviour can be changed with new configuration option apply-prog-options.
• Add flag --[no-]use-root to stack script (default disabled). Used with --compile or --optimize, when enabled all compilation outputs (including the executable) are written to a script-specific location in the scripts directory of the Stack root rather than the script's directory, avoiding clutter of the latter directory.
• Better error message if the value of the STACK_WORK environment variable or --work-dir option is not a valid relative path.
• Stack will use the value of the GH_TOKEN, or GITHUB_TOKEN, environment variable as credentials to authenticate its GitHub REST API requests.
• stack uninstall also shows how to uninstall Stack-supplied tools.

Bug fixes:

• Fix incorrect warning if allow-newer-deps are specified but allow-newer is false. See #6068.
• stack build with --file-watch or --file-watch-poll outputs 'pretty' error messages, as intended. See #5978.
• stack build unregisters any local packages for the sub libraries of a local package that is to be unregistered. See #6046.
• The warning that sublibrary dependency is not supported is no longer triggered by internal libraries.

v2.9.3

See https://haskellstack.org/ for installation and upgrade instructions.

Changes since v2.9.1:

Behavior changes:

• In YAML configuration files, the package-index key is introduced which takes precedence over the existing package-indices key. The latter is deprecated.
• In YAML configuration files, the hackage-security key of the package-index key or the package-indices item can be omitted, and the Hackage Security configuration for the item will default to that for the official Hackage server. See #5870.
• Add the stack config set package-index download-prefix command to set the location of Stack's package index in YAML configuration files.
• stack setup with the --no-install-ghc flag warns that the flag and the command are inconsistent and now takes no action. Previously the flag was silently ignored.
• To support the Haskell Foundation's Haskell Error Index initiative, all Stack error messages generated by Stack itself begin with an unique code in the form [S-nnnn], where nnnn is a four-digit number.
• Test suite executables that seek input on the standard input channel (stdin) will not throw an exception. Previously, they would thow an exception, consistent with Cabal's 'exitcode-stdio-1.0' test suite interface specification. Pass the flag --no-tests-allow-stdin to stack build to enforce Cabal's specification. See #5897

Other enhancements:

• Help documentation for stack upgrade warns that if GHCup is used to install Stack, only GHCup should be used to upgrade Stack. That is because GHCup uses an executable named stack to manage versions of Stack, that Stack will likely overwrite on upgrade.
• Add stack ls dependencies cabal command, which lists dependencies in the format of exact Cabal constraints.
• Add STACK_XDG environment variable to use the XDG Base Directory Specification for the Stack root and Stack's global YAML configuration file, if the Stack root location is not set on the command line or by using the STACK_ROOT environment variable.
• Add stack path --global-config, to yield the full path of Stack's user-specific global YAML configuration file (config.yaml).
• Add an experimental option, allow-newer-deps, which allows users to specify a subset of dependencies for which version bounds should be ignored (allow-newer-deps: ['foo', 'bar']). This field has no effect unless allow-newer is enabled.

Bug fixes:

• Fix ambiguous module name Distribution.PackageDescription, if compiling StackSetupShim with Cabal-syntax-3.8.1.0 in package database. See #5886.
• In YAML configuration files, if the package-indices key (or the hackage-security key of its item) is omitted, the expiration of timestamps
  is now ignored, as intended. See Pantry #63

Thanks to all our contributors for this release:

• drlkf
• Felix Paulusma
• Fraser Murray
• Mike Pilgrem
• Phil de Joux
• theophilebatoz

rc/v2.9.2.1 (release candidate)

Changes since v2.9.1:

Behavior changes:

• In YAML configuration files, the package-index key is introduced which takes precedence over the existing package-indices key. The latter is deprecated.
• In YAML configuration files, the hackage-security key of the package-index key or the package-indices item can be omitted, and the Hackage Security configuration for the item will default to that for the official Hackage server. See #5870.
• Add the stack config set package-index download-prefix command to set the location of Stack's package index in YAML configuration files.
• stack setup with the --no-install-ghc flag warns that the flag and the command are inconsistent and now takes no action. Previously the flag was silently ignored.
• To support the Haskell Foundation's Haskell Error Index initiative, all Stack error messages generated by Stack itself begin with an unique code in the form [S-nnnn], where nnnn is a four-digit number.
• Test suite executables that seek input on the standard input channel (stdin) will not throw an exception. Previously, they would thow an exception, consistent with Cabal's 'exitcode-stdio-1.0' test suite interface specification. Pass the flag --no-tests-allow-stdin to stack build to enforce Cabal's specification. See #5897.

Other enhancements:

• Help documentation for stack upgrade warns that if GHCup is used to install Stack, only GHCup should be used to upgrade Stack. That is because GHCup uses an executable named stack to manage versions of Stack, that Stack will likely overwrite on upgrade.
• Add stack ls dependencies cabal command, which lists dependencies in the format of exact Cabal constraints.
• Add STACK_XDG environment variable to use the XDG Base Directory Specification for the Stack root and Stack's global YAML configuration file, if the Stack root location is not set on the command line or by using the STACK_ROOT environment variable.
• Add stack path --global-config, to yield the full path of Stack's user-specific global YAML configuration file (config.yaml).
• Add an experimental option, allow-newer-deps, which allows users to specify a subset of dependencies for which version bounds should be ignored (allow-newer-deps: ['foo', 'bar']). This field has no effect unless allow-newer is enabled.

Bug fixes:

• Fix ambiguous module name Distribution.PackageDescription, if compiling StackSetupShim with Cabal-syntax-3.8.1.0 in package database. See #5886.
• In YAML configuration files, if the package-indices key (or the hackage-security key of its item) is omitted, the expiration of timestamps
  is now ignored, as intended. See Pantry #63.

v2.9.1

See https://haskellstack.org/ for installation and upgrade instructions.

Changes since v2.7.5:

Behavior changes:

• stack build --coverage will generate a unified coverage report, even if there is only one *.tix file, in case a package has tested the library of another package that has not tested its own library. See #5713
• stack --verbose no longer includes the lengthy raw snapshot layer (rsl) in the debug output by default. The new stack --[no-]rsl-in-log flag enables or disables the inclusion of the rsl in the debug output.

Other enhancements:

• Bump to Hpack 0.35.0.
• On Windows, the installer now sets DisplayVersion in the registry, enabling tools like winget to properly read the version number.
• Adds flag --script-no-run-compile (disabled by default) that uses the --no-run option with stack script (and forces the --compile option). This enables a command like stack --script-no-run-compile Script.hs to behave like stack script <arguments> --no-run --compile -- Script.hs but without having to list all the <arguments> in the Stack interpreter options comment in Script.hs on the command line. That may help test that scripts compile in CI (continuous integration). See #5755
• Fuller help is provided at the command line if a subcommand is missing (for example, stack ls now yields the equivalent of stack ls --help). See #809
• Add build option --cabal-verbosity=VERBOSITY to specify the Cabal verbosity level (the option accepts Cabal's numerical and extended syntax). See #1369
• Add the possibility of a sh script to customise fully GHC installation. See #5585
• tools subcommand added to stack ls, to list stack's installed tools.
• stack uninstall shows how to uninstall Stack.
• --ghc-variant accepts int-native as a variant.

Bug fixes:

• Fix stack clean --full, so that the files to be deleted are not in use. See #5714
• Fix an inconsistency in the pretty formatting of the output of stack build --coverage
• Fix repeated warning about missing parameters when using stack new
• Include pantry-0.5.6: Remove operational and mirror keys from bootstrap key set. See #53
• Pass any CPP options specified via cpp-options: in the Cabal file to GHCi using GHC's -optP flag. See #5608
• On Unix-like operating systems, respect the with-gcc option when installing GHC. See #5609
• Fixed logic in get_isa() in get-stack.sh to exclude systems that don't have x86 in their uname -m output. See #5792.
• Fixed output of stack ls snapshots local on Windows, to behave like that on Unix-like operating systems.
• Fix non-deterministic test failures when executing a test suite for a multi-project repository with parallelism enabled. See #5024

Thanks to all our contributors for this release:

• ARATA Mizuki
• citrusmunch
• Dan Brooks
• Danila Danko
• Emanuel Borsboom
• HallowedDust5
• hs211216
• Idris Raja
• Josh Soref
• Julian Ospald
• Leo Sin
• Maciej Bielecki
• Malte Neuss
• malteneuss
• Marc Etter
• Matt Audesse
• Michael Snoyman
• Mike Pilgrem
• Naoya Yamashita
• Phil de Joux
• Sibi Prabakaran
• Tom Sydney Kerckhove

v2.9.0.1 (release candidate)

Changes since v2.7.5:

Behavior changes:

• stack build --coverage will generate a unified coverage report, even if
  there is only one *.tix file, in case a package has tested the library of
  another package that has not tested its own library. See
  #5713
• stack --verbose no longer includes the lengthy raw snapshot layer (rsl) in
  the debug output by default. The new stack --[no-]rsl-in-log flag enables or
  disables the inclusion of the rsl in the debug output.

Other enhancements:

• Bump to Hpack 0.35.0.
• On Windows, the installer now sets DisplayVersion in the registry, enabling
  tools like winget to properly read the version number.
• Adds flag --script-no-run-compile (disabled by default) that uses the
  --no-run option with stack script (and forces the --compile option).
  This enables a command like stack --script-no-run-compile Script.hs to
  behave like stack script <arguments> --no-run --compile -- Script.hs but
  without having to list all the <arguments> in the Stack interpreter options
  comment in Script.hs on the command line. That may help test that scripts
  compile in CI (continuous integration). See
  #5755
• Fuller help is provided at the command line if a subcommand is missing (for
  example, stack ls now yields the equivalent of stack ls --help). See
  #809
• Add build option --cabal-verbosity=VERBOSITY to specify the Cabal verbosity
  level (the option accepts Cabal's numerical and extended syntax).
  See #1369
• Add the possibility of a sh script to customise fully GHC installation. See
  #5585
• tools subcommand added to stack ls, to list stack's installed tools.
• stack uninstall shows how to uninstall Stack.
• --ghc-variant accepts int-native as a variant.

Bug fixes:

• Fix stack clean --full, so that the files to be deleted are not in use. See
  #5714
• Fix an inconsistency in the pretty formatting of the output of
  stack build --coverage
• Fix repeated warning about missing parameters when using stack new
• Include pantry-0.5.6: Remove operational and mirror keys from bootstrap key
  set #53
• Pass any CPP options specified via cpp-options: in the Cabal file to GHCi
  using GHC's -optP flag. See
  #5608
• On Unix-like operating systems, respect the with-gcc option when installing
  GHC. See #5609
• Fixed logic in get_isa() in get-stack.sh to exclude systems that don't
  have x86 in their uname -m output. See
  5792.
• Fixed output of stack ls snapshots local on Windows, to behave like that on
  Unix-like operating systems.
• Fix non-deterministic test failures when executing a test suite for a
  multi-project repository with parallelism enabled. See
  #5024

v2.7.5

See https://haskellstack.org/ for installation and upgrade instructions.

Changes since v2.7.3:

Behavior changes:

• Cloning git repositories isn't per sub-directory anymore, see
  #5411

Other enhancements:

• stack setup supports installing GHC for macOS aarch64 (M1)

• stack upload supports authentication with a Hackage API key (via
  HACKAGE_KEY environment variable).

Bug fixes:

• Ensure that extra-path works for case-insensitive PATHs on Windows.
  See rio#237
• Fix handling of overwritten ghc and ghc-pkg locations.
  #5597
• Fix failure to find package when a dependency is shared between projects.
  #5680
• stack ghci now uses package flags in stack.yaml
  #5434

Thanks to all our contributors for this release:

• Emanuel Borsboom
• HaskellMouse
• Julian Ospald
• kocielnik
• Matt Audesse
• Michael Snoyman
• MikaelUrankar
• Muhammed Zakir
• Natan Lao
• Patryk Kocielnik
• tkaaad97

v2.7.3

See https://haskellstack.org/ for installation and upgrade instructions.

Changes since v2.7.1:

Other enhancements:

• stack upgrade will download from haskellstack.org before trying
  github.com. See
  #5288
• stack upgrade makes less assumptions about archive format. See
  #5288
• Add a --no-run flag to the script command when compiling.

Bug fixes:

• GHC source builds work properly for recent GHC versions again. See
  #5528
• stack setup always looks for the unpacked directory name to support
  different tar file naming conventions. See
  #5545
• Bump pantry version for better OS support. See
  pantry#33
• When building the sanity check for a new GHC install, make sure to clear
  GHC_PACKAGE_PATH.
• Specifying GHC RTS flags in the stack.yaml no longer fails with an error.
  #5568
• stack setup will look in sandboxed directories for executables, not
  relying on `findExecutables. See
  GHC issue 20074
• Track changes to setup-config properly to avoid reconfiguring on every
  change. See #5578

Thanks to all our contributors for this release:

• Andreas Källberg
• Artur Gajowy
• Felix Yan
• fwcd
• Ketzacoatl
• Matt Audesse
• Michael Snoyman
• milesfrain
• parsonsmatt
• skforg

v2.7.1

See https://haskellstack.org/ for installation and upgrade instructions.

Changes since v2.5.1.1:

Behavior changes:

• stack repl now always warns about GHCi problems with loading multiple
  packages. It also sets now proper working directory when invoked with
  one package. See
  #5421

• custom-setup dependencies are now properly initialized for stack dist.
  This makes explicit-setup-deps no longer required and that option was
  removed. See
  #4006

Other enhancements:

• Nix integration now passes ghcVersion (in addition to existing ghc) to
  shell-file as an identifier that can be looked up in a compiler attribute set.

• Nix integration now allows Nix integration if the user is ready in nix-shell.
  This gets rid of "In Nix shell but reExecL is False" error.

• stack list is a new command to list package versions in a snapshot.
  See #5431

• Consider GHC 9.0 a tested compiler and remove warnings.

• custom-preprocessor-extensions is a new configuration option for allowing
  stack to be aware of any custom preprocessors you have added to Setup.hs.
  See #3491

• Added --candidate flag to upload command to upload a package candidate
  rather than publishing the package.

• Error output using --no-interleaved-output no longer prepends indentating
  whitespace. This allows emacs compilation-mode and vim quickfix to locate
  and track errors. See
  #5523

Bug fixes:

• stack new now suppports branches other than master as default for
  GitHub repositories. See
  #5422

• Ignore all errors from hi-file-parser. See
  #5445 and
  #5486.

• Support basic auth in package-indices. See
  #5509.

• Add support for parsing .hi. files from GHC 8.10 and 9.0. See
  hi-file-parser#2.

Thanks to all our contributors for this release:

• Aaron Allen
• Alexey Kuleshevich
• Andreas Källberg
• Domen Kožar
• Emanuel Borsboom
• Felix Yan
• Jens Petersen
• Kirill Zaborsky
• Marcin Tolysz
• Matt Audesse
• Matthew Wraith
• Michael Snoyman
• Mike Pilgrem
• Simon Michael