From 16fbe589e269d98e47f478e42be40b2b374445d4 Mon Sep 17 00:00:00 2001 From: John Helmert Date: Mon, 16 Sep 2019 14:32:38 -0500 Subject: [PATCH] Update scripts/RELEASE_CHECKLIST.md The list has had several changes - modifications relevant to the switch between GitHub and Gitlab, and commit tagging information is now noted. Importantly, the "Packaging Guide" was removed because it didn't add anything to the document that wasn't already in the checklist, and the "PyPI Credentials" section was removed because storing credentials in plaintext is a bad idea so following it makes little sense. --- scripts/RELEASE_CHECKLIST.md | 38 ++++++++++-------------------------- 1 file changed, 10 insertions(+), 28 deletions(-) diff --git a/scripts/RELEASE_CHECKLIST.md b/scripts/RELEASE_CHECKLIST.md index 6452957..6c03051 100644 --- a/scripts/RELEASE_CHECKLIST.md +++ b/scripts/RELEASE_CHECKLIST.md @@ -1,35 +1,17 @@ Release Checklist ----------------- -1. Switch to the master branch and stash any uncommited changes. +1. Switch to the master branch and stash/commit any uncommited changes. 2. Bump the version number in [tuir/\_\_version\_\_.py](tuir/__version__.py). 3. Update the release notes in the [CHANGELOG.rst](CHANGELOG.rst). + 4. Update the contributor list by running [``scripts/build_authors.py``](scripts/build_authors.py). 5. Re-generate the manpage by running [``scripts/build_manpage.py``](scripts/build_manpage.py). -6. Make sure the bundled packages are up-to-date by running [``scripts/update_packages.py``](scripts/update_packages.py). -7. Commit all changes to the master branch. -8. Clean out any old build/release files by running [``scripts/pip_clean.py``](scripts/pip_clean.py). -9. Build the source tarball and binary wheel: ``$ python3 setup.py sdist bdist_wheel`` -10. Upload the packages to PyPI: ``$ twine upload dist/*`` -11. Verify that the upload was successful: ``$ pip install tuir --upgrade --force-reinstall`` -12. Smoke test the new release on Python 2 and Python 3. -12. Create a new release on Github and copy the release notes from the changelog. -13. Use Github to delete any old branches that have been merged. - -Packaging Guide ---------------- - -The most up-to-date and pragmatic guide on packaging for PyPI is given here (as of Fall 2017): - -https://packaging.python.org/tutorials/distributing-packages/ - -PyPI Credentials ----------------- - -PyPI credentials are stored in plaintext in the **~/.pypirc** file. - -``` -[pypi] -username = michael-lazar -password = secret -``` +6. Commit all changes to the correct branch and tag the correct commit with its version. +7. Smoke test the new release on Python 2 and Python 3. +8. Push the unpublished changes and the tag. +9. Clean out any old build/release files by running [``scripts/pip_clean.py``](scripts/pip_clean.py). +10. Build the source tarball and binary wheel: ``$ python3 setup.py sdist bdist_wheel`` +11. Upload the packages to PyPI: ``$ twine upload dist/*`` +12. Verify that the upload was successful: ``$ pip install tuir --upgrade --force-reinstall`` +13. Delete any old and unused branches that have been merged.