Replace Travis CI with Github Action-based CI. (#14)

Also update README and metadata files.

Author: smolkaj

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: build and test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    # Prime the caches every Monday
+    - cron: 0 1 * * MON
+
+permissions: read-all
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest]
+        ocaml-compiler: [5.0, 4.14, 4.8]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout tree
+        uses: actions/checkout@v3
+
+      - name: Set-up OCaml ${{ matrix.ocaml-compiler }}
+        uses: ocaml/setup-ocaml@v2
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+
+      - run: opam install . --deps-only --with-test --with-doc
+
+      - run: opam exec -- dune build
+
+      - run: opam exec -- dune runtest

README.md

@@ -1,6 +1,8 @@
 *For an older version of this repository based on sedlex, refer to the [sedlex branch](../../tree/sedlex)*.
 
-# Nice Parser [![Build Status](https://travis-ci.org/smolkaj/nice-parser.svg?branch=master)](https://travis-ci.org/smolkaj/nice-parser)
+# Nice Parser
+
+[![Build Status](https://github.com/smolkaj/nice-parser/workflows/build%20and%20test/badge.svg?branch=master)](https://github.com/smolkaj/nice-parser/actions)
 
 Writing an OCaml parser with nice error messages should be easy - and now it is!
 *Nice Parser* comes in two parts:
@@ -14,11 +16,11 @@ In types: `Nice_parser.Make : functor(P : RAW_PARSER) -> NICE_PARSER`.
 
 Using the library and the skeleton, you can get started on your own parser in seconds:
 ```sh
-opam install nice_parser ppx_jane                       # install nice_parser and ppx_driver
-git clone https://github.com/smolkaj/nice-parser.git    # clone this repository
-cd nice-parser && rm -r lib && mv example src           # use example as starting point
-dune build src/example.a                                # try to build...
-dune exec src/bin/main.exe                              # ...and run your parser!
+git clone https://github.com/smolkaj/nice-parser.git  # clone this repository
+cd nice-parser && rm -r lib && mv example src         # use example as starting point
+opam install . --deps-only --with-test                # install dependencies
+dune build                                            # try to build...
+dune exec src/bin/main.exe                            # ...and run your parser!
 ```
 You should see the following output (the error message relies on OCaml >= 4.08's new [source highlighting mechanism](https://github.com/ocaml/ocaml/pull/2096)):
 ```
@@ -45,9 +47,13 @@ The [example skeleton](example) should be self-explanatory.
 
 ## How to build
 Ideally, use OCaml 4.08 or higher (for [beautiful error messages](https://github.com/ocaml/ocaml/pull/2096)).
+All required dependencies can be installed using the [opam](http://opam.ocaml.org) package manager.
 The project can be built using [dune](https://dune.build).
-Consult the [dune-project file](dune-project) for the necessary dependencies;
-all of them can be installed using the [opam](http://opam.ocaml.org) package manager.
+```
+opam install . --deps-only --with-test
+dune build
+dune runtest
+```
 
 ## Suggestions and Improvements
 Suggestions and changes are welcome. Please submit pull requests, or open issues.

ci/travis.docgen.sh

@@ -1,26 +1,39 @@
 (lang dune 1.10)
+
 (using menhir 2.0)
+
 (generate_opam_files true)
 
 (name nice_parser)
+
 (version 1.0.0)
+
 (license MIT)
-(source (github smolkaj/ocaml-parsing))
-(authors "Steffen Smolka <[email protected]>")
-(maintainers "Steffen Smolka <[email protected]>")
-(documentation "https://smolkaj.github.io/ocaml-parsing/nice_parser/")
+
+(source
+ (github smolkaj/nice-parser))
+
+(authors "Steffen Smolka <[email protected]>")
+
+(maintainers "Steffen Smolka <[email protected]>")
+
+(documentation "https://smolkaj.github.io/nice-parser/nice_parser/")
 
 (package
-  (name nice_parser)
-  (synopsis "Nice parsers without the boilerplate")
-  (description "Nice_parser wraps your {menhir, ocamlyacc}-generated parser in a sane interface, eliminating boilerplate code.")
-  (depends
-    (ocaml (>= 4.05.0))
-    (dune (and :build (>= 1.10)))
-    (stdio (<> 0))
-    (base :with-test)
-    (menhir :with-test)
-    (ppx_jane :with-test)
-    (odoc :with-doc)
-  )
-)
+ (name nice_parser)
+ (synopsis "Nice parsers without the boilerplate")
+ (description
+  "Nice_parser wraps your {menhir, ocamlyacc}-generated parser in a sane interface, eliminating boilerplate code.")
+ (depends
+  (ocaml
+   (>= 4.08.0))
+  (dune
+   (and
+    :build
+    (>= 1.10)))
+  (stdio
+   (<> 0))
+  (base :with-test)
+  (menhir :with-test)
+  (ppx_jane :with-test)
+  (odoc :with-doc)))

ci/travis.test.sh

@@ -1,4 +1,3 @@
 (library
-  (public_name nice_parser)
-  (libraries stdio compiler-libs.common)
-)
+ (public_name nice_parser)
+ (libraries stdio compiler-libs.common))

dune-project

@@ -6,14 +6,14 @@ build: [
   ["dune" "runtest" "-p" name "-j" jobs] {with-test}
   ["dune" "build" "-p" name "@doc"] {with-doc}
 ]
-maintainer: ["Steffen Smolka <smolka@cs.cornell.edu>"]
-authors: ["Steffen Smolka <smolka@cs.cornell.edu>"]
-bug-reports: "https://github.com/smolkaj/ocaml-parsing/issues"
-homepage: "https://github.com/smolkaj/ocaml-parsing"
-doc: "https://smolkaj.github.io/ocaml-parsing/nice_parser/"
+maintainer: ["Steffen Smolka <steffen.smolka@gmail.com>"]
+authors: ["Steffen Smolka <steffen.smolka@gmail.com>"]
+bug-reports: "https://github.com/smolkaj/nice-parser/issues"
+homepage: "https://github.com/smolkaj/nice-parser"
+doc: "https://smolkaj.github.io/nice-parser/nice_parser/"
 license: "MIT"
 version: "1.0.0"
-dev-repo: "git+https://github.com/smolkaj/ocaml-parsing.git"
+dev-repo: "git+https://github.com/smolkaj/nice-parser.git"
 synopsis: "Nice parsers without the boilerplate"
 description:
   "Nice_parser wraps your {menhir, ocamlyacc}-generated parser in a sane interface, eliminating boilerplate code."