Skip to content

Commit

Permalink
Merge branch 'stable'
Browse files Browse the repository at this point in the history
  • Loading branch information
mpilgrem committed Feb 25, 2024
2 parents 26abdc0 + 11908c0 commit 3108931
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
10 changes: 10 additions & 0 deletions doc/init_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,13 @@ By default:
* Stack will not initialise if there are conflicting or incompatable user
packages. Pass the flag `--omit-packages` to cause Stack to ignore such
matters while initialising.

If a snapshot is specified at the command line, `stack init` will try to use it.
For further information, see the documentation for the
[`--snapshot`](global_flags.md#-snapshot-option) and
[`--resolver`](global_flags.md#-resolver-option) options.

Otherwise, `stack init` will try to use the following Stackage snapshots in
order of preference, using the first that is compatable: the most recent LTS
Haskell, the most recent Stackage Nightly, and other LTS Haskell (most recent
first).
13 changes: 8 additions & 5 deletions doc/maintainers/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,26 +67,29 @@ Examples:

4. Check the copyright dates, and update if needed.

5. Ensure CI matrices in docs (travis-complex, appveyor, azure) have current
5. Check the backwards compatability section of `CONTRIBUTING.md` is up to
date.

6. Ensure CI matrices in docs (travis-complex, appveyor, azure) have current
stackage snapshots and GHC versions (e.g.
https://github.com/commercialhaskell/stack/pull/4565/files)

6. Update any `stack-*.yaml` that uses a `nightly` snapshot to the latest
7. Update any `stack-*.yaml` that uses a `nightly` snapshot to the latest
nightly (go over the extra-deps too) and ensure the project builds and tests
pass. For example, command:

~~~text
stack build --stack-yaml=… --haddock --test --bench --no-run-benchmarks
~~~

7. The Windows installer is built using an
8. The Windows installer is built using an
[NSIS compiler](https://nsis.sourceforge.io/Main_Page). Check that the NSIS
compiler that will be used is capable of handling
[large strings](https://nsis.sourceforge.io/Special_Builds).

8. Ensure the integration tests pass on Linux, macOS and Windows.
9. Ensure the integration tests pass on Linux, macOS and Windows.

9. Some people prefer, or need, to build Stack with Cabal (the tool). Check
10. Some people prefer, or need, to build Stack with Cabal (the tool). Check
that `cabal.project` is up to date (the specified `with-compiler:`). Check
that `cabal.config` is up to date and is not missing dependencies relevant
on Windows and non-Windows operating systems, following the instructions in
Expand Down
7 changes: 5 additions & 2 deletions doc/new_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@ stack new PACKAGE_NAME [--bare] [--[no-]init] [TEMPLATE_NAME]
By default:

* the project is created in a new directory named after the package. Pass the
`--bare` flag to create the project in the current directory; and
`--bare` flag to create the project in the current directory;

* the project is initialised for use with Stack. Pass the `--no-init` flag to
skip such initialisation.
skip such initialisation; and

* the project template is the one specified by the
[default-template](yaml_configuration.md#default-template) option.

A package name acceptable to Cabal comprises an alphanumeric 'word'; or two or
more such words, with the words separated by a hyphen/minus character (`-`). A
Expand Down
2 changes: 1 addition & 1 deletion doc/pantry.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ There are essentially four different ways of specifying a snapshot location:
for example:

~~~yaml
snapshot: ghc-8.6.5`
snapshot: ghc-8.6.5
~~~

2. Via a URL pointing to a snapshot configuration file, for example:
Expand Down

0 comments on commit 3108931

Please sign in to comment.