From 1658ec7c91d061668ee059a988c89eaa2dab8ef5 Mon Sep 17 00:00:00 2001 From: Adam Meily Date: Wed, 14 Aug 2019 10:39:46 -0400 Subject: [PATCH] add release checklist --- ReleaseChecklist.md | 31 +++++++++++++++++++++++++++++++ requirements/requirements-dev.txt | 1 + setup.py | 8 +++++++- 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 ReleaseChecklist.md diff --git a/ReleaseChecklist.md b/ReleaseChecklist.md new file mode 100644 index 0000000..42bb764 --- /dev/null +++ b/ReleaseChecklist.md @@ -0,0 +1,31 @@ +- [ ] Run tox + ``` + tox -e py37 + ``` + +- [ ] Build the packages + ``` + python setup.py bdist_wheel sdist + ``` + +- [ ] Check the packages + ``` + twine check dist/* + ``` + +- [ ] Upload the packages to to TestPyPi + ``` + twine upload --repository-url https://test.pypi.org/legacy/ dist/* + ``` + +- [ ] Verify everything looks good by going to https://test.pypi.org/project/cincoconfig +- [ ] Upload to PyPI + ``` + twine upload dist/* + ``` + +- [ ] Tag the release + ``` + git tag vX.Y.Z + git push origin vX.Y.Z + ``` diff --git a/requirements/requirements-dev.txt b/requirements/requirements-dev.txt index f8040f9..8f6fab1 100644 --- a/requirements/requirements-dev.txt +++ b/requirements/requirements-dev.txt @@ -7,4 +7,5 @@ pytest-cov sphinx sphinx-autodoc-typehints sphinx-rtd-theme +twine wheel diff --git a/setup.py b/setup.py index 9f08339..7093971 100644 --- a/setup.py +++ b/setup.py @@ -20,15 +20,21 @@ def load_requirements(filename): license='ISC', description='Universal configuration file parser', long_description=open("README.md", 'r').read(), + long_description_content_type='text/markdown', author='Adam Meily', author_email='meily.adam@gmail.com', - url='https://github.com/ameily/cincoconfig', + url='https://cincoconfig.readthedocs.io/en/latest/', packages=['cincoconfig', 'cincoconfig.formats'], install_requires=requirements, extras_require={ 'dev': dev_requirements, 'features': feature_requirements }, + project_urls={ + 'Travis CI': 'https://travis-ci.org/ameily/cincoconfig', + 'Documentation': 'https://cincoconfig.readthedocs.io/en/latest/', + 'Source': 'https://github.com/ameily/cincoconfig/', + }, keywords=['config', 'configuration'], classifiers=[ 'Development Status :: 4 - Beta',