0
Fork 0
mirror of https://github.com/uber/h3-py.git synced 2026-11-16 07:44:46 +00:00
h3-py/dev_notes.md
AJ Friend e054120e1b
Prep for v4.2.0 release (#438)
* prep for v4.2.0 release

* ensure you update the badge on the readme
2025-01-27 11:38:18 -08:00

1.5 KiB

Development notes for h3-py

Install for development

  • git clone git@github.com:uber/h3-py.git
  • cd h3-py
  • make init
  • make test
  • make lint

Docstrings

Updating the H3 submodule

cd src/h3lib
git checkout master
git pull
cd ..
git add h3lib
git commit ...

for a specific version tag:

cd src/h3lib
git checkout v3.7.1  # or whatever version tag you'd like
cd ..
git add h3lib
git commit ...

Resetting the submodule

For when moving between h3-py branches using different versions of the h3lib submodule.

git submodule deinit -f .
git submodule update --init

Releasing a new version

  • update CHANGELOG.md to reflect any changes since the last release
  • update the h3-py version in pyproject.toml
  • if updating the C h3lib version, update the version badge on the readme
  • create PR, get reviews, and merge with these changes
  • go to https://github.com/uber/h3-py/releases and "Draft a new release"
    • set the tag version and the release to the version. e.g., v3.7.2 (alternatively: git tag v3.7.2 && git push origin --tags)
    • add the updated CHANGELOG.md text to the release notes
    • publish release
  • GitHub actions should trigger on the release event and then go on to build and upload the wheels to PyPI