From c599b5fa97172be9a0b3cf175a9c2027882f0a2d Mon Sep 17 00:00:00 2001
From: Jake VanderPlas <vanderplas@google.com>
Date: Mon, 18 Sep 2023 10:35:10 -0700
Subject: [PATCH] ml_dtypes: add documentation on how to release

PiperOrigin-RevId: 566345823
---
 RELEASING.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 RELEASING.md

diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 00000000..4d8aeb2c
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,29 @@
+# Releasing ml_dtypes
+
+To create a new `ml_dtypes` release, take the following steps:
+
+1. Send a pull request updating the version in `pyproject.toml` and
+   `ml_dtypes/__init__.py` to the correct version number, as well as
+   updating the CHANGELOG with the changes since the previous release
+   (an example for the 0.2.0 release is [PR #78]).
+2. Once this is merged, create the release tag and push it to github. An
+   example from the 0.2.0 release:
+   ```
+   $ git checkout main
+   $ git pull upstream main  # upstream is github.com:jax-ml/ml_dtypes.git
+   $ git tag -a v0.2.0 -m "v0.2.0 Release"
+   $ git push upstream v0.2.0
+   ```
+3. Navigate to https://github.com/jax-ml/ml_dtypes/releases/new, and choose
+   this new tag. Copy the change description from CHANGELOG into the release
+   notes, and click *Publish release*.
+4. Publishing the release will trigger the CI jobs that build the wheels
+   and publish the results to PyPI. Navigate to
+   https://github.com/jax-ml/ml_dtypes/actions/ and look for the job
+   associated with this release; monitor it to ensure it finishes green
+   (this will take approximately 30 minutes). Once the build is complete,
+   check https://pypi.org/project/ml-dtypes/ to ensure that the new release
+   is present.
+
+
+[PR #78]: https://github.com/jax-ml/ml_dtypes/pull/78
\ No newline at end of file