• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Releasing ml_dtypes
2
3To create a new `ml_dtypes` release, take the following steps:
4
51. Send a pull request updating the version in `pyproject.toml` and
6   `ml_dtypes/__init__.py` to the correct version number, as well as
7   updating `CHANGELOG.md` with the changes since the previous release
8   (an example for the 0.2.0 release is [PR #78]).
92. Once this is merged, create the release tag and push it to github. An
10   example from the 0.2.0 release:
11   ```
12   $ git checkout main
13   $ git pull upstream main  # upstream is github.com:jax-ml/ml_dtypes.git
14   $ git log  # view commit log & ensure the most recent commit
15              # is your version update PR
16   $ git tag -a v0.2.0 -m "v0.2.0 Release"
17   $ git push upstream v0.2.0
18   ```
193. Navigate to https://github.com/jax-ml/ml_dtypes/releases/new, and select
20   this new tag. Copy the change description from `CHANGELOG.md` into the
21   release notes, and click *Publish release*.
224. Publishing the release will trigger the CI jobs configured in
23   `.github/workflows/wheels.yml`, which will build the wheels and source
24   distributions and publish them to PyPI. Navigate to
25   https://github.com/jax-ml/ml_dtypes/actions/workflows/wheels.yml and
26   look for the job associated with this release; monitor it to ensure it
27   finishes green (this will take approximately 30 minutes).
285. Once the build is complete, check https://pypi.org/project/ml-dtypes/
29   to ensure that the new release is present.
30
31[PR #78]: https://github.com/jax-ml/ml_dtypes/pull/78
32