Skip to content

Commit 97159e0

Browse files
committed
add pypi release doc, and add to sidebar
1 parent 6866bc0 commit 97159e0

2 files changed

Lines changed: 75 additions & 0 deletions

File tree

docs/setup/build-wheel.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Pypi release process
3+
---
4+
5+
Follow the steps to do a manual release on PyPi.
6+
7+
- Please confirm that [Python 3.11.x](https://www.python.org/downloads) with [Pipenv](https://pipenv.pypa.io/en/latest/#install-pipenv-today) is installed and setup on this machine
8+
9+
- Clone the repo
10+
11+
```bash
12+
git clone https://github.com/chkware/cli.git cli-wheel
13+
```
14+
15+
- Change to the directory
16+
17+
```bash
18+
cd cli-wheel
19+
```
20+
21+
- Update version number on `setup.cfg`
22+
23+
```ini
24+
version = 0.X.X
25+
```
26+
27+
- Update version number on `chk/console/main.py`
28+
29+
```python
30+
"""v0.X.X | supported version strings: 0.7.2, ..."""
31+
```
32+
33+
- Update [_docs/CHANGELOG.md_](CHANGELOG.md) with the release _0.X.X_ information
34+
35+
- Make directory for local _virtualenv_ setup
36+
37+
```bash
38+
mkdir ./.venv
39+
```
40+
41+
- Install all required packages
42+
43+
```bash
44+
pipenv install
45+
```
46+
47+
- Install all required packages for build and push to PyPI
48+
49+
```bash
50+
pipenv run pip install -U build twine
51+
```
52+
53+
- Use the environment's python to build
54+
55+
```bash
56+
pipenv run python -m build --wheel --sdist
57+
```
58+
59+
- Push the packages to PyPi. This setup will require your PyPi username and password. So, make sure to setup an account, and have permission to push setup ready on the `chk` package repository.
60+
61+
```bash
62+
pipenv run twine upload dist/*
63+
```
64+
65+
- Publish and push an annotated tag
66+
67+
```bash
68+
git tag -a v0.X.X -m "..."
69+
git push -u origin v0.X.X
70+
```
71+
72+
- [_OPTIONAL_] [build a zipapp](build-zipapp.md), and release a version
73+
74+
A new version is release.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ const sidebars = {
7070
"setup/setup-ext-dev",
7171
"setup/setup-cli-dev",
7272
"setup/setup-site-dev",
73+
"setup/build-wheel",
7374
"setup/build-zipapp",
7475
],
7576
},

0 commit comments

Comments
 (0)