Skip to content

Commit

Permalink
upgrade to opam 2 and dune
Browse files Browse the repository at this point in the history
  • Loading branch information
mroch committed Aug 25, 2021
1 parent 6b4b161 commit 347ac6e
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 44 deletions.
23 changes: 14 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
5 changes: 5 additions & 0 deletions dune-project
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
(lang dune 2.0)

(name vlq)

(formatting disabled)
6 changes: 0 additions & 6 deletions pkg/pkg.ml

This file was deleted.

3 changes: 3 additions & 0 deletions src/dune
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
(library
(name vlq)
(public_name vlq))
6 changes: 0 additions & 6 deletions src/jbuild

This file was deleted.

3 changes: 3 additions & 0 deletions test/dune
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
(tests
(names test)
(libraries vlq ounit2))
12 changes: 0 additions & 12 deletions test/jbuild

This file was deleted.

1 change: 0 additions & 1 deletion vlq.descr

This file was deleted.

26 changes: 16 additions & 10 deletions vlq.opam
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
opam-version: "1.2"
opam-version: "2.0"
synopsis: "A simple library for encoding variable-length quantities."
maintainer: "Marshall Roch <[email protected]>"
authors: ["Marshall Roch <[email protected]>"]
authors: "Marshall Roch <[email protected]>"
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.
"""

0 comments on commit 347ac6e

Please sign in to comment.