Skip to content

Commit c581ef9

Browse files
committed
How to make a new release on PyPi instructions.
1 parent 0ec11e2 commit c581ef9

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,8 +463,12 @@ We see that the symbolic constants are converted back to Python numeric types on
463463
464464
Similarly when we assign an element or slice of the symbolic matrix to a numeric value, they are converted to symbolic constants on the way in.
465465
466+
## Making a New Release
467+
- Make a pull request that bumps the version number in `pyproject.toml`, which follows the major.minor.patch semantic versioning convention.
468+
- Then, go to the URL https://github.com/rai-opensource/spatialmath-python/releases, click draft new release. Click the tag selection dialouge, then click create new tag, and make a tag that matches the semantic version numbers in the pull request you just made. Click "generate release notes", then click publish release. This will automatically kick off the workflow in `.github/workflows/publish.yml` and the new version of the code on PyPi (https://pypi.org/project/spatialmath-python).
469+
466470
## History & Contributors
467471
468472
This package was originally created by [Peter Corke](https://github.com/petercorke) and [Jesse Haviland](https://github.com/jhavl) and was inspired by the [Spatial Math Toolbox for MATLAB](https://github.com/petercorke/spatialmath-matlab). It supports the textbook [Robotics, Vision & Control in Python 3e](https://github.com/petercorke/RVC3-python).
469473
470-
The package is now a collaboration with [Boston Dynamics AI Institute](https://theaiinstitute.com/).
474+
The package is now a collaboration with the [Robotics and AI Institute](https://rai-inst.com/).

0 commit comments

Comments
 (0)