Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.79 KB

HOW-TO-RELEASE.md

File metadata and controls

63 lines (41 loc) · 2.79 KB
Raw

Note to self

How to publish a new release of the herbie-data package on PyPI and conda-forge

Pre-step

Update Herbie version number in

  • Update ./CITATION.cff citation document
  • Update ./docs/_static/switcher.json with a new item for the version you will soon create
    • (You will need to go into the readthedocs.org dashboard and activate the version later.)
  • Make sure all leftover changes on main are committed that you want.
  • Create a tag and release in GitHub.

Note: The tag name should follow the pattern YYYY.MM.0

  • YYYY is the four-digit year the tag is created.
  • MM is the month number the tag is created with no leading zeros (PyPI doesn't care about leading zeros).
  • 0 - The micro update, set to 0 for the first release of the month, otherwise increment by 1 if there is more than one release in the same month (i.e., a bug fix).

    Note: I do NOT prepend the version name with v (I have chosen to not include that.)

📦 Publish to PyPI

This is done automatically by the GitHub Action .github/workflows/release_to_pypi.yml

Just create a release with a tag named 20YY.MM.#

The build process will start automatically.

  1. The action uses the build tool to build my package following the steps from here.
  2. The action then uses pypa/gh-action-pypi-publish to upload the package to PyPI

After the action completes, confirm the file was uploaded to PyPI at https://pypi.org/project/herbie-data/.

🐍 Publish to Conda

Updating the Conda package involves updating the herbie-data feedstock, specifically updating the version in the meta.yml file. You should get a notification from the herbie-data feedstock repo saying that it detected a new version and open a pull request. If it looks good, merge the pull request.

Manually updating the package on conda-forge involves the following steps:

  1. Fork the herbie-data Conda feedstock
  2. Follow the instructions in the README to update the build
    • Update version
    • Update sha256 has for the herbie-data-{version}.tar.gz file (found on PyPI) in the "Download files" tab.
    • Set build to 0 for releasing a new version.
  3. Create pull request.
  4. Follow instructions in the pull request template.

📄 readthedocs

  1. If a new version is included in the version switcher, then you'll need to activate the pages for that version.

Miscellaneous

See PyPI download statistics at: https://pepy.tech/project/herbie-data

Check import time with

python -X importtime herbie/core.py > importtime.txt 2>&1