Skip to content

Commit 9af4e61

Browse files
Update release procedure
1 parent c8fcb38 commit 9af4e61

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

doc/new-release-procedure.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,36 @@
22

33
### Procedure
44
1. To push a new release you must be a maintainer in pypi ([see pypi below](#pypi))
5-
1. Bump version in setup.py (this step is might be done in the PR)
6-
1. Clean out old distribution
5+
2. Bump version in setup.py (this step is might be done in the PR)
6+
3. Clean out old distribution
77
- `rm dist/*`
8-
1. Create the distribution
8+
4. Create the distribution
99
- Create a tar/gzip file with the correct directory structure
10-
- `python setup.py sdist`
10+
```bash
11+
python setup.py sdist
12+
```
1113
- Create the wheel file
12-
- `python setup.py bdist_wheel`
14+
```bash
15+
pip install --upgrade wheel
16+
python setup.py bdist_wheel
17+
```
1318
- check it: `ls dist` should show two files a `.tar.gz` file and a `.whl` file
14-
1. _Optional_ - At this point you could do an optional test installation ([see below](#optional-test-installation))
15-
1. Upload to PYPI
16-
- `twine upload dist/*`
17-
1. Tag
18-
- `git tag -a 2.5.0` (replace version number with the current version from setup.py)
19-
1. If any files were edited (i.e `setup.py`)
19+
5. _Optional_ - At this point you could do an optional test installation ([see below](#optional-test-installation))
20+
6. Upload to PYPI
21+
```bash
22+
pip install --upgrade twine
23+
twine upload dist/*
24+
```
25+
7. If any files were edited (i.e `setup.py`)
2026
- `git commit - a`
2127
- `git push origin master`
22-
1. Push tags
28+
8. Tag
29+
- `git tag -a 2.5.0` (replace version number with the current version from setup.py)
30+
9. Push tags
2331
- `git push --tags`
24-
1. After this you can install
32+
10. After this you can install
2533
- `pip install firefly_client`
26-
1. Make is release with github, using the tag above
34+
11. Make is release with github, using the tag above
2735
- https://github.com/Caltech-IPAC/firefly_client/releases
2836

2937
### PYPI
@@ -35,10 +43,10 @@
3543
### Optional Test installation
3644

3745
1. To create a test release you must be a mainainer on testpypi
38-
1. Create the distribution (see above)
39-
1. `twine upload --repository-url https://test.pypi.org/legacy/ dist/*`
40-
1. `pip uninstall firefly_client`
41-
1. `pip install --verbose --index-url https://testpypi.python.org/pypi firefly_client`
46+
2. Create the distribution (see above)
47+
3. `twine upload --repository-url https://test.pypi.org/legacy/ dist/*`
48+
4. `pip uninstall firefly_client`
49+
5. `pip install --verbose --index-url https://testpypi.python.org/pypi firefly_client`
4250

4351
### Conda and conda-forge
4452

0 commit comments

Comments
 (0)