Skip to content

Commit 01bf272

Browse files
committed
MAINT: add notes on how to release
1 parent ee17557 commit 01bf272

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

RELEASE_HOWTO.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,25 @@ Here's a quick step-by-step for cutting a new release of gatspy.
88

99
2. update version in ``docs/conf.py`` (two places!)
1010

11-
3. create a release tag; e.g.
11+
3. update change log in ``CHANGES.md``
12+
13+
4. create a release tag; e.g.
1214
```
1315
$ git tag -a v0.2 -m 'version 0.2 release'
1416
```
1517

16-
4. push the commits and tag to github
18+
5. push the commits and tag to github
1719

18-
5. confirm that CI tests pass on github
20+
6. confirm that CI tests pass on github
1921

20-
6. under "tags" on github, update the release notes
22+
7. under "tags" on github, update the release notes
2123

22-
7. push the new release to PyPI:
24+
8. push the new release to PyPI:
2325
```
2426
$ python setup.py sdist upload
2527
```
2628

27-
8. change directories to ``doc`` and build the documentation:
29+
9. change directories to ``doc`` and build the documentation:
2830
```
2931
$ cd doc/
3032
$ make html # build documentation
@@ -35,4 +37,4 @@ Here's a quick step-by-step for cutting a new release of gatspy.
3537

3638
1. update version in ``gatspy/__init__.py`` to next version; e.g. '0.3-git'
3739

38-
2. update version in ``doc/conf.py`` to the same (in two places)
40+
2. update version in ``doc/conf.py`` to the same (in two places)

0 commit comments

Comments
 (0)