fairseq/RELEASE.md
Diana Liskovich 73b42f0f3e Refactor release.yml (#4475)
Summary:
# Before submitting

- [ ] Was this discussed/approved via a Github issue? (no need for typos, doc improvements)
- [ ] Did you read the [contributor guideline](https://github.com/pytorch/fairseq/blob/main/CONTRIBUTING.md)?
- [ ] Did you make sure to update the docs?
- [ ] Did you write any new necessary tests?

## What does this PR do?
Fixes # (issue).

## PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

## Did you have fun?
Make sure you had fun coding �

Pull Request resolved: https://github.com/facebookresearch/fairseq/pull/4475

Reviewed By: anupambhatnagar

Differential Revision: D37081823

Pulled By: dianaml0

fbshipit-source-id: b5167aa66e0b873c5f466e1b16a27ca779802780
2022-06-11 11:49:18 -07:00

654 B

Creating a New Release

In order to create a new release:

  1. Navigate to the Fairseq Workflows and find the one named Fairseq Release.

  2. Under Run Workflow choose the branch main and for Release Type enter either major, minor, or patch.

  3. A branch named $new_version-release will be created where the version.txt file is updated. Merge those changes into main.

  4. Make sure that a new PYPI package has been uploaded.

  5. Make sure that a new github release has been created.