Skip to content

Commit 8d45806

Browse files
committed
Enhance release procedure
1 parent b1c2409 commit 8d45806

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

release_procedure.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,16 @@
33
This is the procedure to follow to finalize a release of
44
`tensorflow-determinism`.
55

6-
## 1. Check Version Number
6+
## 1. Merge Release Branch
7+
8+
Thoroughly review the release branch (e.g. `r0.3`) and merge it into master.
9+
Then delete the release branch.
10+
11+
## 2. Check Version Number
712

813
Confirm that the version number in `tfdeterminism/version.py` is correct.
914

10-
## 2. Run Tests
15+
## 3. Run Tests
1116

1217
Run all the tests and make sure they all pass.
1318

@@ -16,13 +21,13 @@ $cd test
1621
$./all.sh
1722
```
1823

19-
## 3. Create Archive
24+
## 4. Create Archive
2025

2126
```
2227
python setup.py sdist
2328
```
2429

25-
## 4. Upload to PyPI
30+
## 5. Upload to PyPI
2631

2732
Upload the archive to the Python Package Index.
2833

@@ -43,7 +48,7 @@ repository: https://test.pypi.org/legacy/
4348
username: <username>
4449
```
4550

46-
### 4a. Test PyPI Server
51+
### 5a. Test PyPI Server
4752

4853

4954
```
@@ -52,15 +57,15 @@ twine upload --repository testpypi dist/tensorflow-determinism-<version>.tar.gz
5257

5358
Review the release online and try installing it.
5459

55-
### 4b. Real PyPI Server
60+
### 5b. Real PyPI Server
5661

5762
```
5863
twine upload --repository pypi dist/tensorflow-determinism-<version>.tar.gz
5964
```
6065

6166
Again, review the release online and try installing it.
6267

63-
## 5. Create GitHub Release
68+
## 6. Create GitHub Release
6469

6570
Finally, on GitHub, create a new release with an appropriate version tag
6671
(e.g. `v0.1.0`).

0 commit comments

Comments
 (0)