diff --git a/docs/how-to/release-a-new-version.md b/docs/how-to/release-a-new-version.md new file mode 100644 index 00000000..9da80265 --- /dev/null +++ b/docs/how-to/release-a-new-version.md @@ -0,0 +1,22 @@ +# How to release a new mquery version + +I never remembe the exact steps, so let's document this once and for all. + +This should be automated someday. + +* [ ] Bump the version + * [ ] pick a new version, make sure you follow semver + * [ ] Update `setup.py` + * [ ] Update `src/utils.py` + * [ ] `git checkout -b release/v1.6.0; git push origin release/v1.6.0` + * [ ] Create a PR and merge it +* [ ] Push a new git tag + * [ ] `git tag v1.6.0` + * [ ] `git push origin v1.6.0` +* [ ] Publish a release on github +* [ ] Build the package + * [ ] `python3 setup.py build` + * [ ] `python3 setup.py sdist` + * [ ] Test the package +* [ ] Publish the pypi package + * [ ] `twine upload dist/mquery-1.6.0.tar.gz`