Maintainers' guide

Jump to bottom

Marco Gorelli edited this page Nov 10, 2020 · 13 revisions

Deploying a new version of the package

Bump the version number:
```
bumpversion patch setup.py nbqa/__init__.py
```
and then
- update the version number in the readme
- git add .
- git commit;
- git push.

Tag:

git tag -a <version number goes here>
git push upstream <version number goes here>

Build:
```
python setup.py sdist bdist_wheel
```
Check:
```
twine check dist/*
```

Deploy:

twine upload dist/nbqa-<version number>*

Update gist at https://gist.github.com/MarcoGorelli/c98f8ef48a5577865f06245a46b3a681

Building documentation

Go to https://readthedocs.org/projects/nbqa/ and press build Make sure that MarcoGorelli/nbQA:master is up-to-date with nbQA-dev/nbQA:master!