Modernize

.github/workflows/workflow.yml

@@ -3,8 +3,8 @@ name: build-and-test
 on:
   pull_request:
   push:
-    branches-ignore:
-      - gh-pages
+    branches:
+      - main
 
 jobs:
   build:
@@ -13,8 +13,11 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
+          - macos-latest
         ocaml-compiler:
-          - 5.0.0
+          - 4.12.0
+          - 4.x
+          - 5.x
 
     runs-on: ${{ matrix.os }}
 
@@ -28,7 +31,10 @@ jobs:
           ocaml-compiler: ${{ matrix.ocaml-compiler }}
 
       - name: Install dependencies
-        run: opam pin . --with-doc --with-test --yes
+        run: opam install . --deps-only --with-test
 
-      - name: Build and test
-        run: ./script/ci
+      - name: Build
+        run: opam exec -- dune build
+
+      - name: Test
+        run: opam exec -- dune runtest

.gitignore

@@ -1,2 +1 @@
 _build
-_opam

.ocamlformat

@@ -1,12 +1,4 @@
-version=0.24.1
+profile = default
+version = 0.25.1
 
-module-item-spacing=compact
-
-space-around-arrays=false
-space-around-lists=false
-space-around-records=false
-space-around-variants=false
-
-cases-exp-indent=2
-
-exp-grouping=preserve
+exp-grouping = preserve

CHANGES.md

@@ -0,0 +1,7 @@
+# Release notes
+
+All notable changes to this project will be documented in this file.
+
+## 1.0.0
+
+- Initial release (@polytypic)

README.md

@@ -1,11 +1,22 @@
-# Low-level multicore utilities for OCaml
+[API reference](https://ocaml-multicore.github.io/multicore-magic/doc/multicore-magic/Multicore_magic/index.html)
+
+# **multicore-magic** — Low-level multicore utilities for OCaml
 
 This is a library of magic multicore utilities intended for experts for
 extracting the best possible performance from multicore OCaml.
 
 Hopefully future releases of multicore OCaml will make this library obsolete!
 
-See
-[the reference manual](https://ocaml-multicore.github.io/multicore-magic/multicore-magic/Multicore_magic/index.html)
-or the [Multicore_magic.mli](src/main/Multicore_magic.mli) signature for the
-API.
+## Development
+
+### Formatting
+
+This project uses [ocamlformat](https://github.com/ocaml-ppx/ocamlformat) (for
+OCaml) and [prettier](https://prettier.io/) (for Markdown).
+
+### To make a new release
+
+1. Update [CHANGES.md](CHANGES.md).
+2. Run `dune-release tag VERSION` to create a tag for the new `VERSION`.
+3. Run `dune-release` to publish the new `VERSION`.
+4. Run `./update-gh-pages-for-tag VERSION` to update the online documentation.

dune

@@ -1 +1 @@
-(dirs src)
+(dirs src test)

dune-project

@@ -1 +1,14 @@
 (lang dune 3.3)
+(name multicore-magic)
+(generate_opam_files true)
+(source (github ocaml-multicore/multicore-magic))
+(authors "Vesa Karvonen <[email protected]>")
+(maintainers "Vesa Karvonen <[email protected]>")
+(homepage "https://github.com/ocaml-multicore/multicore-magic")
+(license ISC)
+(package (name multicore-magic)
+ (synopsis "Low-level multicore utilities for OCaml")
+ (depends 
+  (ocaml (>= 4.12.0))
+  (alcotest (and (>= 1.7.0) :with-test))
+  (odoc (and (>= 2.2.0) :with-doc))))

multicore-magic.opam

@@ -1,16 +1,29 @@
+# This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "1.0.0"
 synopsis: "Low-level multicore utilities for OCaml"
-maintainer: "Vesa Karvonen <[email protected]>"
-authors: "Vesa Karvonen"
+maintainer: ["Vesa Karvonen <[email protected]>"]
+authors: ["Vesa Karvonen <[email protected]>"]
 license: "ISC"
 homepage: "https://github.com/ocaml-multicore/multicore-magic"
 bug-reports: "https://github.com/ocaml-multicore/multicore-magic/issues"
-dev-repo: "git+https://github.com/ocaml-multicore/multicore-magic.git"
 depends: [
-  "dune" {>= "3.3.0"}
-  "ocaml" {>= "5.0.0"}
-  "ocamlformat" {= "0.24.1" & with-test}
-  "odoc" {>= "2.1.1" & with-doc}
+  "dune" {>= "3.3"}
+  "ocaml" {>= "4.12.0"}
+  "alcotest" {>= "1.7.0" & with-test}
+  "odoc" {>= "2.2.0" & with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
 ]
-build: ["dune" "build" "-p" name "-j" jobs]
+dev-repo: "git+https://github.com/ocaml-multicore/multicore-magic.git"