Makefile: add comments about making a release.

ocaml-community · Aug 28, 2024 · 341dee0 · 341dee0
1 parent 3695dcb
commit 341dee0
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -17,5 +17,13 @@ check: test
 clean:
 	dune clean
 
+# To make a release:
+# + check that [make] and [make test] succeed
+# + check that everything has been committed
+# + check that the CI has succeeded
+# + check that [opam lint] is happy
+# + create a tag, e.g. [git tag -a vX.Y.Z]
+# + run [make publishX.Y.Z]
+
 publish%:
 	opam publish --tag=v$* -v $* ocaml-community/cppo