Support binaryen version_98, plus other improvements (#15)

Author: TerrorJack

.github/workflows/pipeline.yml

@@ -6,59 +6,76 @@ on:
 
 jobs:
 
-  build:
-    name: build
-    runs-on: ubuntu-20.04
+  nix:
+    name: nix-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-20.04
+          - macos-10.15
     steps:
 
-      - name: setup-haskell
-        uses: actions/setup-haskell@main
-        with:
-          stack-version: 2.3.3
-          enable-stack: true
-          stack-no-global: true
-
-      - name: setup-binaryen
-        run: |
-          curl \
-            -o /tmp/binaryen.deb \
-            http://deb.debian.org/debian/pool/main/b/binaryen/binaryen_97-1_amd64.deb
-          sudo dpkg -i /tmp/binaryen.deb
-          rm /tmp/binaryen.deb
-
       - name: checkout
         uses: actions/checkout@v2
 
-      - name: build
+      - name: setup-nix
+        uses: cachix/install-nix-action@v11
+        with:
+          nix_path: nixpkgs=./nix/nixpkgs.nix
+
+      - name: setup-cachix
+        uses: cachix/cachix-action@master
+        with:
+          name: asterius
+          signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
+
+      - name: test
         run: |
-          stack test
+          nix run -f . --arg systemBinaryen true -i binaryen.components.tests.test -c test
+          nix run -f . --arg systemBinaryen false -i binaryen.components.tests.test -c test
 
-  sdist:
-    name: sdist
-    runs-on: ubuntu-20.04
+  cabal-windows:
+    name: cabal-windows
+    runs-on: windows-2019
     steps:
 
+      - name: checkout
+        uses: actions/checkout@v2
+
       - name: setup-haskell
         uses: actions/setup-haskell@main
         with:
           ghc-version: 8.10.2
           cabal-version: 3.2.0.0
 
-      - name: setup-binaryen
+      - name: test
         run: |
-          curl \
-            -o /tmp/binaryen.deb \
-            http://deb.debian.org/debian/pool/main/b/binaryen/binaryen_97-1_amd64.deb
-          sudo dpkg -i /tmp/binaryen.deb
-          rm /tmp/binaryen.deb
+          C:\msys64\msys2_shell.cmd -mingw64 -defterm -full-path -here -no-start -c "cabal v2-run binaryen:test"
+
+  sdist:
+    name: sdist
+    runs-on: ubuntu-20.04
+    steps:
 
       - name: checkout
         uses: actions/checkout@v2
 
+      - name: setup-nix
+        uses: cachix/install-nix-action@v11
+        with:
+          nix_path: nixpkgs=./nix/nixpkgs.nix
+
+      - name: setup-cachix
+        uses: cachix/cachix-action@master
+        with:
+          name: asterius
+          signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
+
       - name: sdist
         run: |
-          cabal check
-          cabal v2-sdist all
+          nix-shell --pure --run "cabal check && cabal v2-sdist all"
 
       - name: upload-artifact
         uses: actions/upload-artifact@v2
@@ -71,26 +88,23 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
 
-      - name: setup-haskell
-        uses: actions/setup-haskell@main
-        with:
-          ghc-version: 8.10.2
-          cabal-version: 3.2.0.0
-
-      - name: setup-binaryen
-        run: |
-          curl \
-            -o /tmp/binaryen.deb \
-            http://deb.debian.org/debian/pool/main/b/binaryen/binaryen_97-1_amd64.deb
-          sudo dpkg -i /tmp/binaryen.deb
-          rm /tmp/binaryen.deb
-
       - name: checkout
         uses: actions/checkout@v2
 
+      - name: setup-nix
+        uses: cachix/install-nix-action@v11
+        with:
+          nix_path: nixpkgs=./nix/nixpkgs.nix
+
+      - name: setup-cachix
+        uses: cachix/cachix-action@master
+        with:
+          name: asterius
+          signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
+
       - name: haddock
         run: |
-          cabal v2-haddock --haddock-for-hackage --haddock-hyperlink-source --haddock-quickjump all
+          nix-shell --pure --run "cabal v2-haddock --flags=system-binaryen --extra-include-dirs=\$binaryenIncludeDir --extra-lib-dirs=\$binaryenLibDir --haddock-for-hackage --haddock-hyperlink-source --haddock-quickjump all"
 
       - name: upload-artifact
         uses: actions/upload-artifact@v2

README.md

@@ -8,31 +8,44 @@ API][binaryen-api].
 
 ## Versioning
 
-Binaryen evolves fast and can introduce C API changes in every release. Before
-building the Haskell bindings, please check the Binaryen version and make sure
+Starting from `0.0.5.0`, we bundle the C++ sources of `binaryen` with this
+package, so the package can be built and used as long as the C++ toolchain is
+present in the build environment. The `system-binaryen` Cabal flag defaults to
+`False`, but it can be manually enabled to link against the system-wide
+`binaryen` library and avoid building the bundled C++ library.
+
+| Haskell bindings version | Bundled Binaryen version |
+| ------------------------ | ------------------------ |
+| 0.0.5.\*                 | version_98               |
+
+Older versions of this package links against the system-wide `binaryen` library,
+so before building the package, please check the Binaryen version and make sure
 it's no less than the minimum version listed below.
 
 | Haskell bindings version | Minimum Binaryen version |
-|--------------------------|--------------------------|
-| 0.0.1.*                  | version_91               |
-| 0.0.2.*                  | version_94               |
-| 0.0.3.*                  | version_96               |
-| 0.0.4.*                  | version_97               |
-
+| ------------------------ | ------------------------ |
+| 0.0.1.\*                 | version_91               |
+| 0.0.2.\*                 | version_94               |
+| 0.0.3.\*                 | version_96               |
+| 0.0.4.\*                 | version_97               |
 
 ## How to build
 
-This package relies on the system-provided Binaryen library. As long as that's
-available, a simple `stack build` or `cabal build` command should work.
+A simple `stack build` or `cabal build` command should work.
+
+For Windows `cabal` users: run the build in a msys2 mingw64 shell.
 
-`Nix`-based build is also supported. Install [Stack][stack] and [Nix][nix].
-Then,
+[`nix`][nix]-based build is also supported:
 
 ```shell
-$ stack --nix build
+$ nix-shell --pure --run "cabal v2-run binaryen:test"
+$ nix-shell --pure --run "cabal v2-run binaryen:test --flags=system-binaryen --extra-include-dirs=\$binaryenIncludeDir --extra-lib-dirs=\$binaryenLibDir"
 ```
 
+Use the [`asterius`][cachix-asterius] Cachix bucket for reusing binary cache
+built on CI.
+
 [binaryen]: https://github.com/WebAssembly/binaryen
 [binaryen-api]: https://github.com/WebAssembly/binaryen/blob/master/src/binaryen-c.h
+[cachix-asterius]: https://app.cachix.org/cache/asterius
 [nix]: https://nixos.org/nix
-[stack]: https://docs.haskellstack.org/en/stable/README