RELEASE.md 641 Bytes
Newer Older
Min Xu's avatar
Min Xu committed
1
2
3
## Steps to do a release

- Update the CHANGELOG.md
4
- Update "what's new" in README.md
5
- If needed, update the PyTorch versions in README.md in the Testing section.
Min Xu's avatar
Min Xu committed
6
7
8
9
10
11
- Update `fairscale/__init__.py` and `docs/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
12
13
- visit [this page](https://github.com/facebookresearch/fairscale/tags) and create the newly
  tagged release.