Merge remote-tracking branch 'commercialhaskell/release'

Author: dten

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,9 +3,9 @@ name: Bug Report
 about: Report a bug in Stack
 ---
 
-Please follow the steps below for reporting a bug:
+Please follow the steps below for reporting a bug in Stack:
 
-Make sure that you are using the latest release (currently Stack 2.9.1). See the
+Make sure that you are using the latest release (currently Stack 2.9.3). See the
 [upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade/#upgrade)
 to upgrade.
 
@@ -45,7 +45,7 @@ stack <your command here> <args> --verbose
 
 ~~~text
 stack --version
-Version 2.9.1, Git revision 409d56031b4240221d656db09b2ba476fe6bb5b1 x86_64 hpack-0.35.0
+Version 2.9.3, Git revision 6cf638947a863f49857f9cfbf72a38a48b183e7e x86_64 hpack-0.35.1
 ~~~
 
 ### Method of installation
@@ -55,3 +55,7 @@ Version 2.9.1, Git revision 409d56031b4240221d656db09b2ba476fe6bb5b1 x86_64 hpac
 * Via Cabal (the tool)
 * An unofficial package repository (please specify which)
 * Other (please specify)
+
+### Platform
+
+Your platform (machine architecture and operating system)

.github/ISSUE_TEMPLATE/docs_report.md

@@ -0,0 +1,18 @@
+---
+name: Documentation Report
+about: Report if Stack's documentation appears inaccurate or incomplete
+---
+
+Please report problems with Stack's in-app help and error messages as a Stack bug. Please follow the schema below for reporting if Stack's online documentation appears inaccurate or incomplete:
+
+### Location of the documentation
+
+Please provide the link to the documentation in question. All headings have permanent links associated with them.
+
+### Is it inaccurate?
+
+Why do you think the documentation is wrong?
+
+### Is it incomplete?
+
+What do you think is missing from the documentation?

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,7 +3,7 @@ name: Feature Request
 about: Request a feature be added to Stack, or discuss such a feature
 ---
 
-Make sure that you are using the latest release (currently Stack 2.9.1). See the
+Make sure that you are using the latest release (currently Stack 2.9.3). See the
 [upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade/#upgrade)
 to upgrade.
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,12 +1,13 @@
 ---
 name: Question
-about: Ask a question about Stack usage
+about: Ask a question about how to use Stack
 ---
 
-Do you have a question regarding Stack's usage that isn't covered by the online
+Do you have a question about how to use Stack that is not covered by the online
 [documentation](http://haskellstack.org)? In that case please ask your question
-on [Stack Overflow](http://stackoverflow.com) and use
-[the haskell-stack tag](http://stackoverflow.com/questions/tagged/haskell-stack).
+at the [Haskell Community](https://discourse.haskell.org/) forum or on
+[Stack Overflow](http://stackoverflow.com) (use the
+[haskell-stack](http://stackoverflow.com/questions/tagged/haskell-stack) tag).
 This way your question will be more easily discoverable by other people with the
 same question.
 
@@ -15,15 +16,15 @@ the [stack-templates](https://github.com/commercialhaskell/stack-templates)
 repository instead.
 
 If you still want to ask the question here instead, please make sure that you
-are using the latest release (currently Stack 2.9.1). See the
+are using the latest release (currently Stack 2.9.3). See the
 [upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade/#upgrade)
 to upgrade.
 
 ### Stack version
 
 ~~~text
 stack --version
-Version 2.9.1, Git revision 409d56031b4240221d656db09b2ba476fe6bb5b1 x86_64 hpack-0.35.0
+Version 2.9.3, Git revision 6cf638947a863f49857f9cfbf72a38a48b183e7e x86_64 hpack-0.35.1
 ~~~
 
 ### Method of installation

.github/workflows/integration-tests.yml

@@ -11,9 +11,14 @@ on:
     - '**'
   workflow_dispatch:
 
-# As of 11 August 2022, ubuntu-latest, windows-latest and macos-latest come with
-# Stack 2.7.5. windows-latest comes with NSIS 3.08, for which the default value
-# of the 'Unicode' installer attribute is 'true'.
+# Stack will use the value of the GH_TOKEN environment variable to authenticate
+# its requests of the GitHub REST API, providing a higher request rate limit.
+env:
+  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+# As of 5 May 2023, ubuntu-latest, windows-latest and macos-latest come
+# with Stack 2.9.3 and GHC 9.6.1. windows-latest comes with NSIS 3.08, for which
+# the default value of the 'Unicode' installer attribute is 'true'.
 
 jobs:
   integration-tests:
@@ -49,21 +54,12 @@ jobs:
           ~\AppData\Roaming\stack
           ~\AppData\Local\Programs\stack
         key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}-${{ matrix.cache-bust }}
-    - name: Update PATH on Windows
-      if: startsWith(runner.os, 'Windows')
-      run: |
-        # On Windows, `stack upgrade` fails to overwrite the Stack executable at
-        # C:\hostedtoolcache\windows\stack\2.9.1\x64\, so add location of
-        # upgraded Stack executable to the PATH for subsequent steps:
-        Add-Content $env:GITHUB_PATH "C:\Users\runneradmin\AppData\Roaming\local\bin"
+
     - name: Install deps and run checks
       shell: bash
       run: |
         set -ex
 
-        # Stack 2.9.3 is required to build Stack
-        stack upgrade
-
         if [[ "${{ matrix.os }}" == "ubuntu-latest" ]]
         then
           # Retry installing nix due to nondeterministic error

.github/workflows/lint.yml

@@ -27,5 +27,4 @@ jobs:
       run: |
         set -ex
         hlint src/
-        hlint src/ --cpp-define=WINDOWS=1
-        hlint test/ --cpp-simple
+        hlint test/

.github/workflows/unit-tests.yml

@@ -9,8 +9,8 @@ on:
     - rc/**
   workflow_dispatch:
 
-# As of 14 November 2022, ubuntu-latest, windows-latest and macos-latest come
-# with Stack 2.9.1 and GHC 9.4.2.
+# As of 5 May 2023, ubuntu-latest, windows-latest and macos-latest come
+# with Stack 2.9.3 and GHC 9.6.1.
 
 jobs:
   pedantic:
@@ -67,21 +67,12 @@ jobs:
           ~\AppData\Roaming\stack
           ~\AppData\Local\Programs\stack
         key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}-${{ matrix.extra-suffix }}
-    - name: Update PATH on Windows
-      if: startsWith(runner.os, 'Windows')
-      run: |
-        # On Windows, `stack upgrade` fails to overwrite the stack executable at
-        # C:\hostedtoolcache\windows\stack\2.9.1\x64\, so add location of
-        # upgraded Stack executable to the PATH for subsequent steps:
-        Add-Content $env:GITHUB_PATH "C:\Users\runneradmin\AppData\Roaming\local\bin"
+
     - name: Run tests
       shell: bash
       run: |
         set -ex
 
-        # Stack 2.9.3 is required to build Stack
-        stack upgrade
-
         if [[ "${{ matrix.extra-suffix }}" == "alpine" ]]
         then
             mkdir -p ~/.stack

.hindent.yaml

@@ -51,50 +51,15 @@
     - Network.HTTP.StackClient
 
 # Not considered useful hints
-- ignore: {name: "Redundant do"}
-- ignore: {name: "Use section"}
-- ignore: {name: "Use camelCase"}
-- ignore: {name: "Use list comprehension"}
-- ignore: {name: "Redundant if"}
-- ignore: {name: "Avoid lambda"}
-- ignore: {name: "Eta reduce"}
-- ignore: {name: "Use fmap"}  # specific for GHC 7.8 compat
-- ignore: {name: "Parse error"}  # we trust the compiler over HLint
-- ignore: {name: "Use =="}  # Creates infinite loops in `EQ` using expressions
-- ignore: {name: "Evaluate"}
-- ignore: {name: "Use &&&"}
-- ignore: {name: "Redundant compare"}
-- ignore: {name: "Use Just"}
-- ignore: {name: "Avoid lambda using `infix`"}
-
-# Added in hlint-2.0.10, ignoring for now
-- ignore: {name: "Unnecessary hiding"}
-- ignore: {name: "Use lambda-case"}
-
 - ignore:
-    name: "Use fewer imports"
+    name: "Use camelCase"
     within:
-    - System.Process.Read  # Related to 'Hide post-AMP warnings' comment
-    - Stack.Exec  # ifdef for System.Process.Read
-
-# Related to 'explicit pattern matching is clearer' comment
+    - System.Terminal
 - ignore:
-    name: "Use fromMaybe"
+    name: "Avoid lambda using `infix`"
     within:
-    - Stack.Types.Config.explicitSetupDeps
-
-# For clarity (related to do syntax)
-- ignore:
-    name: "Reduce duplication"
-    within:
-    - Network.HTTP.Download.VerifiedSpec
-    - Stack.PackageDumpSpec
-    - Stack.Types.StackT
-    - Stack.Docker
-
-# Gives an incorrect hint that breaks type checking due to mismatched types
+    - System.Process.Pager.pageWriter
 - ignore:
-    name: "Too strict maybe"
+    name: "Unused LANGUAGE pragma"
     within:
-    - Stack.Config
-    - Stack.Package
+    - StackSetupShim

.hlint.yaml

@@ -294,10 +294,10 @@ executable that it compiles from Haskell source code. The executable compiles
 that code with a dependency on the version of Cabal that ships with the
 specified GHC compiler. Each release of Stack will aim to support all versions
 of GHC and the Cabal package in Stackage snapshots published within seven years
-of the release. For example, snapshot LTS Haskell 2.22, published on
-9 August 2015, was the last to provide GHC 7.8.4 which comes with
-`Cabal-1.18.1.5`. Until, at least, 9 August 2022, Stack releases would aim
-to support GHC 7.8.4 and `Cabal-1.18.1.5`.
+of the release. For example, snapshot LTS Haskell 7.0, published on
+14 September 2016, was the first LTS Haskell snapshot to provide GHC 8.0.1 which
+comes with `Cabal-1.24.0.0`. Until, at least, 13 September 2023, Stack releases
+would aim to support the immediate predecessor, GHC 7.10.3 and `Cabal-1.22.5.0`.
 
 When a version of the Stack executable actually ceases to support a version of
 GHC and `Cabal`, that should be recorded in Stack's
@@ -466,6 +466,15 @@ Where again, `<PATTERN>` is the name of the folder listed in the
 [test/integration/tests/](https://github.com/commercialhaskell/stack/tree/master/test/integration/tests)
 directory.
 
+You can disable a few integration tests through the -n option : 
+
+~~~text
+stack build --flag stack:integration-tests stack --exec "stack-integration-test -n <PATTERN1> -n <PATTERN2>"
+~~~
+
+To disable folders named after `<PATTERN1>` and `<PATTERN2>`
+It's especially useful when some tests are taking a while to complete.
+
 ## Continuous integration (CI)
 
 We use [GitHub Actions](https://docs.github.com/en/actions) to do CI on Stack.

CONTRIBUTING.md

@@ -1,5 +1,71 @@
 # Changelog
 
+## v2.11.1 - 2023-05-18
+
+**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](https://github.com/commercialhaskell/stack/issues/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](https://github.com/commercialhaskell/stack/issues/6086).
+* `stack build` with `--file-watch` or `--file-watch-poll` outputs 'pretty'
+  error messages, as intended. See
+  [#5978](https://github.com/commercialhaskell/stack/issues/5978).
+* `stack build` unregisters any local packages for the sub libraries of a local
+  package that is to be unregistered. See
+  [#6046](https://github.com/commercialhaskell/stack/issues/6046).
+* The warning that sublibrary dependency is not supported is no longer triggered
+  by internal libraries.
+
 ## v2.9.3 - 2022-12-16
 
 **Changes since v2.9.1:**
@@ -921,6 +987,15 @@ Behavior changes:
   download a template, Stack will check whether that template had
   been downloaded before. In that case, the cached version will be
   used. See [#3850](https://github.com/commercialhaskell/stack/issues/3850).
+* In Stack's script interpreter, `-- stack --verbosity=info script` and
+  `-- stack script --verbosity=info` now have the same effect and both override
+  the `--verbosity=error` default in the interpreter. Previously the default
+  meant the former was equivalent to
+  `-- stack --verbosity=info script --verbosity=error` and the latter was
+  equivalent to `-- stack --verbosity=error script --verbosity=info`, with the
+  subcommand's global option having precedence over the Stack command's
+  global option in each case. See
+  [#5326](https://github.com/commercialhaskell/stack/issues/5326).
 
 Other enhancements:
 
@@ -2073,7 +2148,7 @@ Behavior changes:
 * Remove deprecated valid-wanted field.
 * Docker: mount home directory in container
   [#1949](https://github.com/commercialhaskell/stack/issues/1949).
-* Deprecate `--local-bin-path` instead `--local-bin`.
+* Deprecate `stack path --local-bin-path`; instead use `--local-bin`.
 * `stack image`: allow absolute source paths for `add`.
 
 Other enhancements:

ChangeLog.md

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2022, Stack contributors
+Copyright (c) 2015-2023, Stack contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

LICENSE

@@ -6,15 +6,22 @@
 
 Stack is a cross-platform program for developing Haskell projects. It is intended for Haskellers both new and experienced.
 
-See [haskellstack.org](http://haskellstack.org) or the [doc](./doc) directory for more
-information.
+See [haskellstack.org](http://haskellstack.org), or the [doc](./doc) directory
+of this repository, for more information.
+
+### Learning to use Stack
+
+If are learning to use Stack and have questions, a discussion at the
+[Haskell Community](https://discourse.haskell.org/) forum may help. See its
+'Learn' category.
 
 ### Community
 
 You can participate with the Stack community in the following areas:
 
-* [Haskell Foundation Slack](https://haskell-foundation.slack.com/join/shared_invite/zt-z45o9x38-8L55P27r12YO0YeEufcO2w#/shared-invite/email)
-    * `#stack-users` for general Stack discussion
-    * `#stack-collaborators` for working on the Stack code base
-* [Stack Google Group mailing list](https://groups.google.com/g/haskell-stack)
-* [Haskell Community Discourse](https://discourse.haskell.org/)
+* the [Haskell Community](https://discourse.haskell.org/) forum
+* the Haskell Foundation's
+  [Slack workspace](https://haskell-foundation.slack.com/join/shared_invite/zt-z45o9x38-8L55P27r12YO0YeEufcO2w#/shared-invite/email)
+    * `#stack-users` channel, for general Stack discussion
+    * `#stack-collaborators` channel, for working on Stack's code base
+* the [Google Group mailing list](https://groups.google.com/g/haskell-stack) for Stack