Skip to content

Commit

Permalink
added RELEASING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
blurks committed Apr 26, 2022
1 parent 1d1369a commit 40f9ca1
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Releasing pynumerals

- Do platform test via tox:
```shell
tox -r
```

- Make sure flake8 passes:
```shell
flake8 src
```

- Update the version number, by removing the trailing `.dev0` in:
- `setup.cfg`
- `src/pynumerals/__init__.py`

- Create the release commit:
```shell
git commit -a -m "release <VERSION>"
git push origin
```

- Create a release tag:
```
gh release create
```

- Release to PyPI:
```shell
rm dist/*
python -m build -n
twine upload dist/* -u __token__ -p"..."
```

- Change version for the next release cycle, i.e. incrementing and adding .dev0
- `setup.cfg`
- `src/pynumerals/__init__.py`

- Commit/push the version change:
```shell
git commit -a -m "bump version for development"
git push origin
```

0 comments on commit 40f9ca1

Please sign in to comment.