init research

malli/docs/releasing.md

@@ -0,0 +1,22 @@
+# Making a Malli release
+
+1. Make sure `CHANGELOG.md` mentions all relevant unreleased changes
+2. Recommended: update dependencies `clj -M:outdated --upgrade`
+   * Gotchas:
+    * The script tries to upgrade :clojure-11 alias as well. This
+      should not be done, as it is used to test the compatibility with
+      clojure 11
+    * If shadow-cljs is updgraded, remember to update package.json as well
+   * Make a PR out of this to get the CI to run all the tests!
+3. Pick a new version number. Remember: we use [BreakVer](https://www.taoensso.com/break-versioning)
+4. Set the version number
+   * Add a title to `CHANGELOG.md`
+   * Change the `<version>` and `<tag>` fields in `pom.xml`
+5. Push to `master`
+6. Create a release via the [GitHub UI](https://github.com/metosin/malli/releases/new)
+   * Use the version number as the tag name, eg. `0.22.33`
+   * Copypaste the changelog from `CHANGELOG.md` to the text field
+7. Once the release is published, the `release` GitHub Action will build a release and deploy it to Clojars.
+   * See progress here: https://github.com/metosin/malli/actions/workflows/release.yml
+8. Check that the release is listed on clojars: https://clojars.org/metosin/malli
+9. Navigate to the cljdoc of the new release to trigger cljdoc build: https://cljdoc.org/versions/metosin/malli