Update the release procedure

mazeppa-dev · Jan 5, 2025 · f99a8a7 · f99a8a7
1 parent 5dd8f04
commit f99a8a7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -988,9 +988,17 @@ The definition of `eval` is now complete.
  1. Type `dune build` to generate `mazeppa.opam`.
  1. Update `CHANGELOG.md`.
  1. Release the project in [GitHub Releases].
+    1. Generate a source code archive and include it in the release:
+       <br>`git archive HEAD -o mazeppa-<major>.<minor>.<patch>.tar.gz`
+ 1. Type `git pull && opam publish`.
+    1. Edit the generated `opam` file with the correct archive URL and the checksums (by running `md5sum` and `sha512sum`).
 
 [GitHub Releases]: https://github.com/mazeppa-dev/mazeppa/releases
 
+Including the output of `git archive` is needed because GitHub does not guarantee [stability of source code archives]. With a static asset, we will always get the same checksum, which is crucial for packaging.
+
+[stability of source code archives]: https://github.blog/open-source/git/update-on-the-future-stability-of-source-code-archives-and-hashes/
+
 ## FAQ
 
 ### Is Mazeppa production-ready?