Skip to content

Commit

Permalink
Add Makefile for release
Browse files Browse the repository at this point in the history
  • Loading branch information
stsewd committed Jan 19, 2021
1 parent 61bd0cc commit 3249fec
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 14 deletions.
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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 [email protected] 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
20 changes: 9 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 [email protected] dist/*
make tag
make release
1 change: 1 addition & 0 deletions readthedocs_ext/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__version__ = '2.1.2'
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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.2',
version=__version__,
author='Read the Docs, Inc',
author_email='[email protected]',
url='http://github.com/readthedocs/readthedocs-sphinx-ext',
Expand All @@ -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'],
Expand Down

0 comments on commit 3249fec

Please sign in to comment.