Skip to content

Commit

Permalink
Added a release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Oct 29, 2024
1 parent 89b0ba5 commit d1aaeb2
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions RELEASE-CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Releasing a new version of hakyll

1. Update the version in `hakyll.cabal` and update the `CHANGELOG.md` file to describe changes associated with this version;
2. Commit changes to `hakyll.cabal` and `CHANGELOG.md`;
3. Tag the commit and push to GitHub:

```bash
$ git tag -a "vW.X.Y.Z" && git push origin "vW.X.Y.Z"
```

4. Create a source distribution:

```bash
$ cabal sdist
Wrote tarball sdist to
(...)/dist-newstyle/sdist/hakyll-W.X.Y.Z.tar.gz
```

5. Upload to Hackage:

```bash
$ cabal upload --publish (...)/dist-newstyle/sdist/hakyll-W.X.Y.Z.tar.gz
```

That's it!

0 comments on commit d1aaeb2

Please sign in to comment.