summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJohn J. Camilleri <john@digitalgrammars.com>2020-09-18 10:49:21 +0200
committerJohn J. Camilleri <john@digitalgrammars.com>2020-09-18 10:49:21 +0200
commitd95b3efd6bdea90cc37be5179527a2791b2b7717 (patch)
treef2ce8906ab8f324ae9bbe6691fa149a3128e1576 /src
parentdb8b111e72ea25b407e8f4de88df692a7bcea300 (diff)
Add instructions for uploading PGF2 to Hackage
Diffstat (limited to 'src')
-rw-r--r--src/runtime/haskell-bind/HACKAGE.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/runtime/haskell-bind/HACKAGE.md b/src/runtime/haskell-bind/HACKAGE.md
new file mode 100644
index 000000000..d931ef8f9
--- /dev/null
+++ b/src/runtime/haskell-bind/HACKAGE.md
@@ -0,0 +1,10 @@
+# Instructions for uploading to Hackage
+
+You will need a Hackage account for steps 4 & 5.
+
+1. Bump the version number in `pgf2.cabal`
+2. Add details in `CHANGELOG.md`
+3. Run `stack sdist` (or `cabal sdist`)
+4. Visit `https://hackage.haskell.org/upload` and upload the file `./.stack-work/dist/x86_64-osx/Cabal-2.2.0.1/pgf2-x.y.z.tar.gz` (or Cabal equivalent)
+5. If successful, upload documentation with `./stack-haddock-upload.sh pgf2 x.y.z` (compilation on Hackage's servers will fail because of missing C libraries)
+6. Commit and push to this repository (`gf-core`)