docs: Release checklist (#999)

Co-authored-by: Erik Svedang <erik@Eriks-iMac.local>
This commit is contained in:
Erik Svedäng 2020-11-22 22:24:04 +01:00 committed by GitHub
parent 244df27942
commit 26ed4b7b52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

28
docs/ReleaseChecklist.md Normal file
View File

@ -0,0 +1,28 @@
# Release Checklist
Do all of these things (somewhat) in order:
# 1. Update Cabal project version
See the second line of the file [CarpHask.cabal](../CarpHask.cabal).
# 2. Update the "Welcome to Carp X.Y.Z" REPL message
See [Main.hs](../App/Main.hs).
# 3. Make a commit on master
```bash
$ git commit -m "Release X.Y.Z"
```
# 4. Tag the commit and push it
```bash
$ git tag vX.Y.Z
$ git push --tags
```
# 5. Update the blurb in README.md
See [README.md](../README.md)