Add changelog

Author: stsewd

CHANGELOG.rst

@@ -3,10 +3,12 @@ release: clean
 	git pull origin master
 	python setup.py sdist bdist_wheel
 	python -m twine upload dist/*
+
+tag:
 	git tag `python -c "print(__import__('sphinx_search').__version__)"`
 	git push --tags
 
 clean:
 	rm -rf dist/
 
-.PHONY: release clean
+.PHONY: release clean tag

Makefile

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+.. include:: ../CHANGELOG.rst

docs/changelog.rst

@@ -32,12 +32,16 @@ Make sure you have the latest version of these packages:
 
    python -m pip install --upgrade setuptools wheel twine
 
-Update the version in ``sphinx_search/__init__.py``,
-and run ``make release``, this will:
+- Update the version in ``sphinx_search/__init__.py`` and ``package.json``.
+- Run ``npm run build`` and ``npm run changelog``.
+- Open a pull request with the changes.
+
+After the pull request is merged, run ``make release``, this will:
 
 - Checkout and update your master branch.
 - Generate the distribution archives in ``dist/``.
 - Upload the archives from ``dist/`` to PyPI.
-- Create a tag from ``__version__`` and push it to GitHub.
+
+Now you can tag the release with ``make tag``.
 
 .. note:: Make sure you don't have any uncommitted changes before releasing.

docs/development.rst

@@ -12,3 +12,4 @@
    testing
    js-api-reference
    get-involved
+   changelog

docs/index.rst

@@ -1,9 +1,10 @@
 {
   "name": "sphinx-es-suggest",
-  "version": "0.0.1",
+  "version": "0.1.0rc3",
   "description": "Enable search-as-you-type feature.",
   "scripts": {
-    "build": "gulp"
+    "build": "gulp",
+    "changelog": "gh-changelog -o readthedocs -r readthedocs-sphinx-search -e '' -f CHANGELOG.rst"
   },
   "repository": {
     "type": "git",
@@ -26,7 +27,8 @@
     "gulp-csso": "^3.0.1",
     "gulp-rename": "^1.4.0",
     "gulp-uglify": "^3.0.2",
-    "run-sequence": "^2.2.1"
+    "run-sequence": "^2.2.1",
+    "github-changelog": "git+https://github.com/agjohnson/github-changelog.git"
   },
   "browserslist": [
     "last 10 versions",