rc/v2.15.6.1

v2.15.6.1 (release candidate)

Release notes:

• This release fixes potential bugs.

Changes since v2.15.5:

Major changes:

• Stack 2.15.5 and earlier cannot build with Cabal (the library) version 3.12.0.0. Stack can now build with that Cabal version.

Behaviour changes:

• Stack's StackSetupShim executable, when called with repl and stack-initial-build-steps, no longer uses Cabal's replHook to apply initialBuildSteps but takes a more direct approach.

Bug fixes:

• Fix a regression introduced in Stack 2.15.1 that caused a 'no operation' stack build to be slower than previously.

v2.15.5

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

Release notes:

• This release fixes potential bugs.

Changes since v2.15.3:

Behaviour changes:

• Following the handover of the Stackage project to the Haskell Foundation, the default value of the urls key is
  latest-snapshot: https://stackage-haddock.haskell.org/snapshots.json.
• Stack no longer includes the snapshot package database when compiling the setup executable for a package with build-type: Configure.

Thanks to all our contributors for this release:

• Mike Pilgrem

rc/v2.15.4.1 (release candidate)

Release notes:

• This release fixes potential bugs.

Changes since v2.15.3:

Behaviour changes:

• Following the handover of the Stackage project to the Haskell Foundation, the default value of the urls key is latest-snapshot: https://stackage-haddock.haskell.org/snapshots.json.
• Stack no longer includes the snapshot package database when compiling the setup executable for a package with build-type: Configure.

v2.15.3

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

Release notes:

• With one exception, this release fixes bugs.

Changes since v2.15.1:

Behavior changes:

• stack path --global-config, --programs, and --local-bin no longer set up Stack's environment.

Bug fixes:

• Due to a bug, Stack 2.15.1 did not support versions of GHC before 8.2. Stack now supports GHC versions from 8.0.
• --haddock-for-hackage does not ignore --haddock-arguments.
• On Windows, package locations that are Git repositories with submodules now work as intended.
• The ghc, runghc and runhaskell commands accept --package values that are a list of package names or package identifiers separated by spaces and, in the case of package identifiers, in the same way as if they were specified as targets to stack build.

Thanks to all our contributors for this release:

• Mike Pilgrem
• Siyuan Chen

v2.15.1

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

Release notes:

• After an upgrade from an earlier version of Stack, on first use only, Stack 2.15.1 may warn that it had trouble loading the CompilerPaths cache.
• The hash used as a key for Stack's pre-compiled package cache has changed, following the dropping of support for Cabal versions older than 1.24.0.0.

Changes since v2.13.1:

Behavior changes:

• Stack does not leave *.hi or *.o files in the setup-exe-src directory of the Stack root, and deletes any corresponding to a setup-<hash>.hs or setup-shim-<hash>.hs file, to avoid GHC issue #21250.
• If Stack's Nix integration is not enabled, Stack will notify the user if a nix executable is on the PATH. This usually indicates the Nix package manager is available. In YAML configuration files, the notify-if-nix-on-path key is introduced, to allow the notification to be muted if unwanted.
• Drop support for Intero (end of life in November 2019).
• stack path --stack-root no longer sets up Stack's environment and does not load Stack's configuration.
• Stack no longer locks on configuration, so packages (remote and local) can be configured in parallel. This increases the effective concurrency of builds that before would use fewer threads. Reconsider your --jobs setting accordingly. See #84.
• Stack warns that its support for Cabal versions before 2.2.0.0 is deprecated and may be removed in the next version of Stack. Removal would mean that projects using snapshots earlier than lts-12.0 or nightly-2018-03-18 (GHC 8.4.1) might no longer build. See #6377.
• If Stack's --resolver option is not specified, Stack's unpack command with a package name will seek to update the package index before seeking to download the most recent version of the package in the index.
• If the version of Cabal (the library) provided with the specified GHC can copy specific components, Stack will copy only the components built and will not build all executable components at least once.

Other enhancements:

• Consider GHC 9.8 to be a tested compiler and remove warnings.
• Stack can build packages with dependencies on public sub-libraries of other packages.
• Add flag --no-init to Stack's new command to skip the initialisation of the newly-created project for use with Stack.
• The HTML file paths produced at the end of stack haddock are printed on separate lines and without a trailing dot.
• Add option of the form --doctest-option=<argument> to stack build, where doctest is a program recognised by versions of the Cabal library from 1.24.0.0.
• Experimental: Add flag --haddock-for-hackage to Stack's build command (including the haddock synonym for build --haddock) to enable building local packages with flags to generate Haddock documentation, and an archive file, suitable for upload to Hackage. The form of the Haddock documentation generated for other packages is unaffected.
• Experimental: Add flag --documentation (-d for short) to Stack's upload command to allow uploading of documentation for packages to Hackage.
• stack new no longer rejects project templates that specify a package.yaml in a subdirectory of the project directory.
• Stack will notify the user if Stack has not been tested with the version of GHC that is being user or a version of Cabal (the library) that has been found. In YAML configuration files, the notify-if-ghc-untested and notify-if-cabal-untested keys are introduced, to allow the notification to be muted if unwanted.
• The compiler version is included in Stack's build message (e.g. stack> build (lib + exe + test) with ghc-9.6.4).
• Add flag --candidate to Stack's unpack command, to allow package candidates to be unpacked locally.
• Stack will notify the user if a specified architecture value is unknown to Cabal (the library). In YAML configuration files, the notify-if-arch-unknown key is introduced, to allow the notification to be muted if unwanted.
• Add option --filter <item> to Stack's ls dependencies text command to filter out an item from the results, if present. The item can be $locals for all local packages.
• Add option --snapshot as synonym for --resolver.
• Add the config set snapshot command, corresponding to the config set resolver command.

Bug fixes:

• Fix the Curator instance of ToJSON, as regards expect-haddock-failure.
• Better error message if a resolver: or snapshot: value is, in error, a YAML number.
• Stack accepts all package names that are, in fact, acceptable to Cabal.
• Stack's sdist command can check packages with names that include non-ASCII characters.

Thanks to all our contributors for this release:

• Bryan Richter
• Dash Lu
• Jason Shipman
• Marco Zocca
• Markus Schirp
• Mike Pilgrem
• Olivier Benz
• Phil de Joux
• theophilebatoz

rc/v2.15.0.1 (release candidate)

Release notes:

• After an upgrade from an earlier version of Stack, on first use only, Stack 2.15.1 may warn that it had trouble loading the CompilerPaths cache.
• The hash used as a key for Stack's pre-compiled package cache has changed, following the dropping of support for Cabal versions older than 1.24.0.0.

Changes since v2.13.1:

Behavior changes:

• Stack does not leave *.hi or *.o files in the setup-exe-src directory of the Stack root, and deletes any corresponding to a setup-<hash>.hs or setup-shim-<hash>.hs file, to avoid GHC issue #21250.
• If Stack's Nix integration is not enabled, Stack will notify the user if a nix executable is on the PATH. This usually indicates the Nix package manager is available. In YAML configuration files, the notify-if-nix-on-path key is introduced, to allow the notification to be muted if unwanted.
• Drop support for Intero (end of life in November 2019).
• stack path --stack-root no longer sets up Stack's environment and does not load Stack's configuration.
• Stack no longer locks on configuration, so packages (remote and local) can be configured in parallel. This increases the effective concurrency of builds that before would use fewer threads. Reconsider your --jobs setting accordingly. See #84.
• Stack warns that its support for Cabal versions before 2.2.0.0 is deprecated and may be removed in the next version of Stack. Removal would mean that projects using snapshots earlier than lts-12.0 or nightly-2018-03-18 (GHC 8.4.1) might no longer build. See #6377.
• If Stack's --resolver option is not specified, Stack's unpack command with a package name will seek to update the package index before seeking to download the most recent version of the package in the index.
• If the version of Cabal (the library) provided with the specified GHC can copy specific components, Stack will copy only the components built and will not build all executable components at least once.

Other enhancements:

• Consider GHC 9.8 to be a tested compiler and remove warnings.
• Stack can build packages with dependencies on public sub-libraries of other packages.
• Add flag --no-init to Stack's new command to skip the initialisation of the newly-created project for use with Stack.
• The HTML file paths produced at the end of stack haddock are printed on separate lines and without a trailing dot.
• Add option of the form --doctest-option=<argument> to stack build, where doctest is a program recognised by versions of the Cabal library from 1.24.0.0.
• Experimental: Add flag --haddock-for-hackage to Stack's build command (including the haddock synonym for build --haddock) to enable building with flags to generate Haddock documentation, and an archive file, suitable for upload to Hackage.
• Experimental: Add flag --documentation (-d for short) to Stack's upload command to allow uploading of documentation for packages to Hackage.
• stack new no longer rejects project templates that specify a package.yaml in a subdirectory of the project directory.
• Stack will notify the user if Stack has not been tested with the version of GHC that is being user or a version of Cabal (the library) that has been found. In YAML configuration files, the notify-if-ghc-untested and notify-if-cabal-untested keys are introduced, to allow the notification to be muted if unwanted.
• The compiler version is included in Stack's build message (e.g. stack> build (lib + exe + test) with ghc-9.6.4).
• Add flag --candidate to Stack's unpack command, to allow package candidates to be unpacked locally.
• Stack will notify the user if a specified architecture value is unknown to Cabal (the library). In YAML configuration files, the notify-if-arch-unknown key is introduced, to allow the notification to be muted if unwanted.
• Add option --filter <item> to Stack's ls dependencies text command to filter out an item from the results, if present. The item can be $locals for all local packages.

Bug fixes:

• Fix the Curator instance of ToJSON, as regards expect-haddock-failure.
• Better error message if a resolver: or snapshot: value is, in error, a YAML number.
• Stack accepts all package names that are, in fact, acceptable to Cabal.
• Stack's sdist command can check packages with names that include non-ASCII characters.

v2.13.1

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

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.
• Binaries are now provided 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).
• stack hpc report, stack list, stack templates and stack uninstall output their information to the standard output stream rather than to the standard error stream. Logging is still to the standard error stream.
• stack upgrade no longer assumes that binary upgrade is not supported on a AArch64 machine architecture.

Other enhancements:

• Bump to Hpack 0.36.0.
• 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).
• Restore message suffix due to warnings with dump-logs: warning (broken with Stack 2.11.1).
• On Windows, the local-programs-path directory can now be on a different drive to the system temporary directory and MSYS2 will still be installed.

Thanks to all our contributors for this release:

• Andrei Dziahel
• Charles Taylor
• David Hewson
• Jens Petersen
• Markus Schirp
• Mike Pilgrem
• Olivier Benz
• Phil de Joux
• Simon Hengel

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.