README.md
1release.hs
2==========
3
4This tool automates some aspects of releasing a new version of Stack. It
5currently handles some tasks that need to be performed on each platform:
6building the release, running integration tests, and other pre-release checks.
7
8See [Checklist](../../doc/maintainers/releases.md) of
9additional manual release steps.
10
11Prerequisites
12-------------
13
14These must be installed in the PATH to use the release tool:
15
16- stack
17- git (for Windows, [msysgit](https://msysgit.github.io) is recommended).
18
19Invocation
20----------
21
22Usage: `stack etc/scripts/release.hs [OPTIONS] TARGET`
23
24The tool must be run in the root of the working tree.
25
26### Options
27
28The release tool is shake-based, so all standard shake options apply. In
29addition, the following options are accepted:
30
31* `--allow-dirty`: by default, the `check` rule aborts if the working tree is
32 dirty, but this will allow it to continue.
33 uploaded to.
34
35### Targets
36
37* `release`: check and build.
38* `check`: run pre-release checks.
39* `build`: build and sign the binary distribution.
40* `clean`: delete the build artifacts.
41