Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit 1c6be40

Browse files
committed
Document release process
1 parent 979c452 commit 1c6be40

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
release: clean
2+
git checkout master
3+
git pull origin master
24
python setup.py sdist bdist_wheel
35
python -m twine upload dist/*
6+
git tag `python -c "print(__import__('sphinx_search').__version__)"`
7+
git push --tags
48

59
clean:
610
rm -rf dist/

docs/development.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,22 @@ Generate minified JS and CSS files via ``Gulp``:
2222

2323
Run the test suite with ``tox``. More information about testing is
2424
available at :doc:`Testing page <testing>`.
25+
26+
Releasing
27+
---------
28+
29+
Make sure you have the latest version of these packages:
30+
31+
.. code-block:: bash
32+
33+
python -m pip install --upgrade setuptools wheel twine
34+
35+
Update the version in ``sphinx_search/__init__.py``,
36+
and run ``make release``, this will:
37+
38+
- Checkout and update your master branch.
39+
- Generate the distribution archives in ``dist/``.
40+
- Upload the archives from ``dist/`` to PyPI.
41+
- Create a tag from ``__version__`` and push it to GitHub.
42+
43+
.. note:: Make sure you don't have any uncommitted changes before releasing.

0 commit comments

Comments
 (0)