Skip to content

Commit

Permalink
[skip ci] update release.md (#896)
Browse files Browse the repository at this point in the history
* [skip ci] update release.md

* [skip ci] minor edit
  • Loading branch information
Anupam Bhatnagar committed Dec 24, 2021
1 parent 38af6d3 commit 541bb8c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
## Steps to do a release

### New Approach
- Go to the [fairscale release workflow](https://github.com/facebookresearch/fairscale/actions/workflows/release.yml) 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]((https://semver.org/spec/v2.0.0.html)) enter one of the following three values for _Release Type_:
- _patch_
- _minor_
- _major_
- Click __Run Workflow__.
- Verify [fairscale/version.py](https://github.com/facebookresearch/fairscale/blob/main/fairscale/version.py) has been updated.
- Verify a new [PyPI package](https://pypi.org/project/fairscale/) has been published.
- Verify a new [Github release](https://github.com/facebookresearch/fairscale/releases) has been created.

---
### Old Approach

- Update the CHANGELOG.md
- Update "what's new" in README.md
- If needed, update the PyTorch versions in README.md in the Testing section.
Expand Down

0 comments on commit 541bb8c

Please sign in to comment.