Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.5 KB

RELEASE.md

File metadata and controls

44 lines (32 loc) · 1.5 KB

How to make a release

Bumping the version

Run the following. Use <part> = 0, 1, 2 for major, minor or patch depending on the release. For example if the version is 1.5.2 then the major version is 1, the minor version is 5, and the patch version is 2. See https://nbdev.fast.ai/api/release.html#bump-version for more details

nbdev_bump_version --part <part>

Publishing

You will need to have an API token for PyPi (or TestPyPi). Ask the current project owners for access.

Set your ~/.pypirc file as follows.

[distutils]
index-servers =
    pypi
    testpypi

[pypi]
username = __token__
password = <PyPI token>

[testpypi]
username = __token__
password = <TestPyPI token>

Run the following to publish to PyPi (or TestPypi). The <REPOSITORY> value is either pypi or testpypi.

./scripts/publish2pypi.sh <REPOSITORY>

Updating release notes and tagging a release

  1. Document the release notes in CHANGELOG.md
  2. Run nbdev_release_git to create entries for the release page.
    • You'll need to create a GitHub personal access token for this if you haven't already. See the nbdev.release docs, under the Setup section, for more details.

Submitting

Create a PR and tag it as the release version. The tag should be in the format vX.Y.Z where X, Y, and Z are the major, minor and patch version numbers respectively.