diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01a2cdb..343f3d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,17 +31,22 @@ disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue. ## License + By contributing to ocaml-vlq, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree. ## Release Process -1. Install `topkg-care`: `opam install topkg-care` -2. Review the changes since last version: `topkg status` -3. Write the release notes: `topkg log edit` -4. Commit the release notes: `topkg log commit` -5. Tag the distribution with a version: `topkg tag` -6. Create the distribution archive: `topkg distrib` -7. Upload the archive to GitHub: `topkg publish distrib` -8. Create an opam package: `topkg opam pkg` -9. Submit it to OCaml's opam repository: `topkg opam submit` +1. Install `dune-release`: `opam install dune-release` +2. Install dependencies: `opam install --deps-only --with-test .` +3. Update `CHANGES.md`, being careful to follow the existing format +4. Commit `CHANGES.md` and `git push` +5. Run some sanity checks: `dune-release lint` +6. Run the tests: `opam exec dune test` +7. Tag the distribution with a version: `dune-release tag` +8. Create the distribution archive: `dune-release distrib` +9. Upload the archive to GitHub: `dune-release publish distrib` +10. Create an opam package: `dune-release opam pkg` +11. Submit it to OCaml's opam repository: `dune-release opam submit` + +For more details, see `dune-release help release`. diff --git a/dune-project b/dune-project new file mode 100644 index 0000000..3b65793 --- /dev/null +++ b/dune-project @@ -0,0 +1,5 @@ +(lang dune 2.0) + +(name vlq) + +(formatting disabled) diff --git a/pkg/pkg.ml b/pkg/pkg.ml deleted file mode 100644 index 5ea7f0c..0000000 --- a/pkg/pkg.ml +++ /dev/null @@ -1,6 +0,0 @@ -(* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved *) - -#use "topfind" -#require "topkg-jbuilder" - -let () = Topkg_jbuilder.describe ~licenses:[ Topkg.Pkg.std_file "LICENSE" ] () diff --git a/src/dune b/src/dune new file mode 100644 index 0000000..688ec28 --- /dev/null +++ b/src/dune @@ -0,0 +1,3 @@ +(library + (name vlq) + (public_name vlq)) diff --git a/src/jbuild b/src/jbuild deleted file mode 100644 index 370e101..0000000 --- a/src/jbuild +++ /dev/null @@ -1,6 +0,0 @@ -(jbuild_version 1) - -(library ( - (name vlq) - (public_name vlq) -)) diff --git a/test/dune b/test/dune new file mode 100644 index 0000000..4e3f8b3 --- /dev/null +++ b/test/dune @@ -0,0 +1,3 @@ +(tests + (names test) + (libraries vlq ounit2)) diff --git a/test/jbuild b/test/jbuild deleted file mode 100644 index 18d1d82..0000000 --- a/test/jbuild +++ /dev/null @@ -1,12 +0,0 @@ -(jbuild_version 1) - -(executable ( - (name test) - (libraries (vlq oUnit)) -)) - -(alias ( - (name runtest) - (deps (test.exe)) - (action (run ${<})) -)) diff --git a/vlq.descr b/vlq.descr deleted file mode 100644 index 1332ddd..0000000 --- a/vlq.descr +++ /dev/null @@ -1 +0,0 @@ -A simple library for encoding variable-length quantities. diff --git a/vlq.opam b/vlq.opam index 3492a41..f2ac97e 100644 --- a/vlq.opam +++ b/vlq.opam @@ -1,15 +1,21 @@ -opam-version: "1.2" +opam-version: "2.0" +synopsis: "A simple library for encoding variable-length quantities." maintainer: "Marshall Roch " -authors: ["Marshall Roch "] +authors: "Marshall Roch " +license: "MIT" homepage: "https://github.com/flowtype/ocaml-vlq" doc: "https://github.com/flowtype/ocaml-vlq" -license: "MIT" -dev-repo: "https://github.com/flowtype/ocaml-vlq.git" bug-reports: "https://github.com/flowtype/ocaml-vlq/issues" -depends: -[ - "jbuilder" {build & >= "1.0+beta7"} - "ounit" {test & >= "2.0.0"} +depends: [ + "ocaml" + "dune" {build & >= "2.0"} + "ounit2" {with-test} +] +build: [ + ["dune" "build" "-p" name "-j" jobs] + ["dune" "runtest" "-p" name "-j" jobs] {with-test} ] -build: [["jbuilder" "build" "-p" name "-j" jobs]] -build-test: [["jbuilder" "runtest" "-p" name "-j" jobs]] +dev-repo: "git+https://github.com/flowtype/ocaml-vlq.git" +description: """ +A simple library for encoding variable-length quantities. +"""