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 c3593ecae5
Add notes on making a release (#179)
* adding some notes on making a release

* capital

* Update dev_notes.md
2021-03-02 20:23:23 -08:00

1.2 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 ...

Releasing a new version

  • update CHANGELOG.md to reflect any changes since the last release
  • update the h3-py version in src/h3/_version.py
  • create, get reviews, and merge a PR 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