copy over text from release.md in plotly.py

plotly · emilykl · Jan 30, 2025 · Jan 15, 2025 · Jan 15, 2025 · Jan 15, 2025
commit 65a78631ea7f4d5d520370293c28ddf96c367653
diff --git a/release.md b/release.md
@@ -0,0 +1,49 @@
+## Release process - `plotly-geo` package
+
+The `plotly-geo` package contains the shape file resources used by plotly.py.
+These files are relatively large and change infrequently so it is useful
+to release them in a separate package.
+
+### Update version
+
+Update the version of the `plotly-geo` package in
+`packages/python/plotly-geo/setup.py`.
+
+This version is not intended to match the version of plotly.py.
+
+### Update CHANGELOG
+
+Add a new entry to the CHANGELOG at `packages/python/plotly-geo/CHANGELOG.md`
+and commit the changes.
+
+### Tag Release
+
+Create a new tag for the release
+
+```bash
+(plotly_dev) $ git checkout master
+(plotly_dev) $ git stash
+(plotly_dev) $ git pull origin master
+(plotly_dev) $ git tag plotly-geo-vX.Y.Z
+(plotly_dev) $ git push origin plotly-geo-vX.Y.Z
+```
+
+### Publishing to PYPI
+
+Publish the final version to PyPI
+
+```bash
+(plotly_dev) $ cd packages/python/plotly-geo
+(plotly_dev) $ python setup.py sdist bdist_wheel
+(plotly_dev) $ twine upload dist/plotly-geo-X.Y.Z.tar.gz
+(plotly_dev) $ twine upload dist/plotly_geo-X.Y.Z-py3-none-any.whl
+```
+
+### Publish to plotly anaconda channel
+
+From `packages/python/plotly-geo`, build the conda package
+```bash
+(plotly_dev) $ conda build recipe/
+```
+
+Then upload to the plotly anaconda channel as described above