From 2cce799ce9f27aafa742f437d0a6e3fa0f6849c7 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 19 Jan 2021 14:46:15 -0500 Subject: [PATCH] Add Makefile for release --- Makefile | 16 ++++++++++++++++ README.rst | 20 +++++++++----------- readthedocs_ext/__init__.py | 1 + setup.py | 7 ++++--- 4 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2514f4b --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +release: clean + git checkout master + git pull origin master + python setup.py sdist bdist_wheel + python -m twine upload --sign --identity security@readthedocs.org dist/* + +tag: + git checkout master + git pull origin master + git tag `python -c "print(__import__('readthedocs_ext').__version__)"` + git push --tags + +clean: + rm -rf dist/ + +.PHONY: release clean tag diff --git a/README.rst b/README.rst index ce53741..ef35140 100644 --- a/README.rst +++ b/README.rst @@ -3,9 +3,9 @@ Read the Docs Sphinx Extensions .. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg :target: https://pypi.python.org/pypi/readthedocs-sphinx-ext - :alt: Pypi Version -.. image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext.svg?branch=master - :target: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext + :alt: Pypi Version +.. image:: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext.svg?style=svg + :target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext :alt: Build Status This module adds extensions that make Sphinx easier to use. @@ -21,13 +21,11 @@ We currently ship: Releasing --------- -#. Increment the version in ``setup.py`` -#. Tag the release in git: ``git tag $NEW_VERSION``. -#. Push the tag to GitHub: ``git push --tags origin master`` -#. Upload the package to PyPI: +#. Increment the version in ``readthedocs_ext.__init__.py`` +#. Open a PR with the changes +#. To create a tag and push to PyPI run: - .. code:: bash + .. code:: bash - $ rm -rf dist/ - $ python setup.py sdist bdist_wheel - $ twine upload --sign --identity security@readthedocs.org dist/* + make tag + make release diff --git a/readthedocs_ext/__init__.py b/readthedocs_ext/__init__.py index e69de29..2d31b1c 100644 --- a/readthedocs_ext/__init__.py +++ b/readthedocs_ext/__init__.py @@ -0,0 +1 @@ +__version__ = '2.1.3' diff --git a/setup.py b/setup.py index c9240b0..a479ac9 100755 --- a/setup.py +++ b/setup.py @@ -1,10 +1,12 @@ import codecs -from setuptools import setup, find_packages +from setuptools import find_packages, setup + +from readthedocs_ext import __version__ setup( name='readthedocs-sphinx-ext', - version='2.1.3', + version=__version__, author='Read the Docs, Inc', author_email='dev@readthedocs.com', url='http://github.com/readthedocs/readthedocs-sphinx-ext', @@ -14,7 +16,6 @@ package_dir={'': '.'}, packages=find_packages('.', exclude=['tests']), long_description=codecs.open("README.rst", "r", "utf-8").read(), - # trying to add files... include_package_data=True, package_data={ '': ['_static/*.js', '_static/*.js_t', '_static/*.css', '_templates/*.tmpl'],