- Go to the fairscale release workflow in Github actions.
- In the Run Workflow dropdown, select the branch from which you wish to release. The default value is main and should be used in almost all cases.
- In adherence to Semantic Versioning enter one of the following three values for Release Type:
- patch
- minor
- major
- Click Run Workflow.
- Verify fairscale/version.py has been updated.
- Verify a new PyPI package has been published.
- Verify a new Github release has been created.
- Update the CHANGELOG.md
- Update "what's new" in README.md
- If needed, update the PyTorch versions in README.md in the Testing section.
- Update
fairscale/__init__.py
anddocs/source/conf.py
for the new version number - git commit the change with title like "[chore] 0.3.1 release"
- make a tag, like
git tag v0.3.1
- git push --tags origin [your/branch]
python3 setup.py sdist
to build a new package (will be in dist/)python3 -m twine upload --repository pypi dist/*
to upload to pypi- visit this page and create the newly tagged release.