Release preparation

Author: mpilgrem

ChangeLog.md

@@ -1,9 +1,12 @@
 # Changelog
 
-## Unreleased changes
+## v3.1.0.1 (release candidate)
 
 Release notes:
 
+* The change in major version from 2.x to 3.1 marks the dropping of support for
+  versions of GHC before 8.4, deprecated in Stack 2.15.1.
+
 **Changes since v2.15.7:**
 
 Behavior changes:

cabal.config

@@ -165,7 +165,7 @@ constraints:
   , socks ==0.6.1
   , split ==0.2.5
   , splitmix ==0.1.0.5
-  , stack ==2.16.0
+  , stack ==3.1.0.1
   , static-bytes ==0.1.0
   , stm ==2.5.1.0
   , stm-chans ==3.0.0.9

doc/GUIDE.md

@@ -507,7 +507,7 @@ also known as *snapshots*. We mentioned the LTS snapshots, and you can get quite
 a bit of information about it at
 [https://www.stackage.org/lts](https://www.stackage.org/lts), including:
 
-* The appropriate value (`lts-22.13`, as is currently the latest LTS)
+* The appropriate value (`lts-22.28`, as is currently the latest LTS)
 * The GHC version used
 * A full list of all packages available in this snapshot
 * The ability to perform a Hoogle search on the packages in this snapshot
@@ -525,25 +525,25 @@ towards by default as well).
 
 ## Snapshots and changing your compiler version
 
-Let's explore package sets a bit further. Instead of `lts-22.13`, let's change
+Let's explore package sets a bit further. Instead of `lts-22.28`, let's change
 our `stack.yaml` file to use the
 [latest nightly](https://www.stackage.org/nightly). Right now, this is currently
-2024-03-20 - please see the snapshot from the link above to get the latest.
+2024-07-05 - please see the snapshot from the link above to get the latest.
 
 Then, commanding `stack build` again will produce:
 
 ~~~text
 stack build
-# Downloaded nightly-2024-03-20 build plan.
+# Downloaded nightly-2024-07-05 build plan.
 # build output ...
 ~~~
 
 We can also change snapshots on the command line, which can be useful in a
 Continuous Integration (CI) setting, like on Travis. For example, command:
 
 ~~~text
-stack --snapshot lts-21.25 build
-# Downloaded lts-21.25 build plan.
+stack --snapshot lts-22.27 build
+# Downloaded lts-22.27 build plan.
 # build output ...
 ~~~
 

doc/global_flags.md

@@ -87,7 +87,7 @@ specific configuration [option](yaml_configuration.md#ghc-variant).
 
 ## `--[no-]hpack-force` flag
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 Default: Disabled
 

doc/yaml_configuration.md

@@ -984,7 +984,7 @@ Integer indicating how many simultaneous downloads are allowed to happen.
 
 ### default-init-snapshot
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 Default: As for the [`stack init`](init_command.md) command when no snapshot is
 specified at the command line.
@@ -1113,7 +1113,7 @@ compiler's binary directory - will take precedence over those specified here
 
 ### file-watch-hook
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 Specifies the location of an executable or `sh` shell script to be run after
 each attempted build with
@@ -1218,7 +1218,7 @@ This option is incompatible with `system-ghc: true`.
 
 ### global-hints-location
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 Default:
 
@@ -1296,7 +1296,7 @@ Template Haskell.
 
 ### hpack-force
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 Default: `false`
 
@@ -1411,7 +1411,7 @@ modify-code-page: false
 
 ### msys-environment
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 Restrictions: Windows systems only.
 
@@ -2156,7 +2156,7 @@ esac
 
 ### `--file-watch` post-processing
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 3.1.1](https://github.com/commercialhaskell/stack/releases/tag/v3.1.1)
 
 On Unix-like operating systems and Windows, Stack's `build --file-watch`
 post-processing can be fully customised by specifying an executable or a `sh`

package.yaml

@@ -2,7 +2,7 @@
 spec-version: 0.35.0
 
 name: stack
-version: '3.1.0.0'
+version: '3.1.0.1'
 synopsis: The Haskell Tool Stack
 description: |
   Please see the documentation at <https://docs.haskellstack.org>

src/Stack/Init.hs

@@ -638,7 +638,7 @@ getRecommendedSnapshots snapshots =
 -- |Yields the minimum LTS supported by Stack.
 minSupportedLts :: SnapName
 -- See https://github.com/commercialhaskell/stack/blob/master/ChangeLog.md
--- under Stack version UNRELEASED.
+-- under Stack version 3.1.1.
 minSupportedLts = LTS 12 0
 
 findCabalDirs ::

stack.cabal

@@ -1,11 +1,11 @@
 cabal-version: 2.0
 
--- This file has been generated from package.yaml by hpack version 0.37.0.
+-- This file has been generated from package.yaml by hpack version 0.36.0.
 --
 -- see: https://github.com/sol/hpack
 
 name:           stack
-version:        3.1.0.0
+version:        3.1.0.1
 synopsis:       The Haskell Tool Stack
 description:    Please see the documentation at <https://docs.haskellstack.org>
                 for usage information.