Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Releasing (markdown)

Jirka Borovec 2020-10-21 00:35:50 +02:00
parent b0830d1b07
commit b105beeacc
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Releasing.md

@ -2,18 +2,17 @@
This job is a sweet end after hard work of fixing bugs and adding new features abut till very crucial because when a package is released to `pip` cannot be changed...
**Note** that `pip` takes the package and sign with the release version, this version is unique and unlike GitHub release once it is released it does not allow to (after removing the original one) use its release number anymore in future...
**Note** that `pip` takes the package and sign with the release version, this version is unique and unlike GitHub release, once it is released it does not allow to (after removing the original one) use its release number anymore in the future...
### Before the release
### Release process
1. check that all tests are passing and all badges are fine
2. double check the docs (even we have docs build among check it is better to check `latest` build)
1. check that all tests are passing and all badges are fine - green
2. double check the docs (even we have docs build among check it is better to check `latest` [build](https://pytorch-lightning.readthedocs.io/en/latest/))
3. set the release version in `__init__`
4. create a tag with the same version (not Release yet)
5. check created docs for this tag on Read-The-Docs and add the link to README
6. add release number and date to last changes in CHANGELOG and remove redundant blank lines
7. create `sdist` locally and check if the attached package decoration (it is generated from our Readme) is correct and all images are shown
8. Finally, create the release which is automatically pushed to `pip`
4. check that you have included all substantial changes in [CHANGELOG.md](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/CHANGELOG.md) together with release number and date (and remove redundant blank lines in list)
5. _[optional]_ create `sdist` locally and check if the attached package decoration (it is generated from our Readme) is correct and all images are shown
6. Finally, [create the release](https://github.com/PyTorchLightning/pytorch-lightning/releases/new) which is automatically pushed to `pip`
7. Open [Read-The-Docs](https://readthedocs.org/projects/pytorch-lightning/) and build release docs for this new release
### Release notes
@ -25,4 +24,4 @@ The release notes shall be composed of the following three sections:
### After the release
- do any promo as needed...
- add me section to CHANGELOG and keep in mind that already created PRs are adding their changes to past release which shall be moved to new unreleased section...
- add me section to CHANGELOG and keep in mind that already created PRs are adding their changes to past release which shall be moved to the new unreleased section...