Skip to content

Commit f1034dc

Browse files
committed
Move the release process into the Sphinx documentation
1 parent 0ee69f4 commit f1034dc

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

RELEASE.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,4 @@ These roles are covered by tools like `build <https://pypa-build.readthedocs.io/
3434
:hidden:
3535

3636
changelog
37+
release-process

docs/release-process.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
===============
2+
Release Process
3+
===============
4+
5+
Actual mechanics of making the release:
6+
7+
- Update the changelog manually, and commit the changes.
8+
- Install :pypi:`bump2version`::
9+
10+
pip install bump2version
11+
12+
- Run it to bump the version strings within the project, like::
13+
14+
bump2version minor
15+
16+
- Push the commit and tags to GitHub.
17+
- To build and upload the distribution files, run::
18+
19+
flit publish

0 commit comments

Comments
 (0)