|
1 | 1 | # Release Checklist
|
2 | 2 |
|
3 | 3 | - [ ] Get `main` to the appropriate code release state.
|
| 4 | + [GitHub Actions](https://github.com/marcusvolz/strava_py/actions) should be |
| 5 | + running cleanly for all merges to `main`. |
| 6 | + [](https://github.com/marcusvolz/strava_py/actions) |
4 | 7 |
|
5 |
| -* [ ] Start from a freshly cloned repo: |
| 8 | +- [ ] Go to the [Releases page](https://github.com/marcusvolz/strava_py/releases) and |
6 | 9 |
|
7 |
| -```bash |
8 |
| -cd /tmp |
9 |
| -rm -rf strava_py |
10 |
| -git clone https://github.com/marcusvolz/strava_py |
11 |
| -cd strava_py |
12 |
| -``` |
13 |
| - |
14 |
| -- [ ] (Optional) Create a distribution and release on **TestPyPI**: |
| 10 | + - [ ] Click "Draft a new release" |
15 | 11 |
|
16 |
| -```bash |
17 |
| -python -m pip install -U pip build keyring twine |
18 |
| -rm -rf build dist |
19 |
| -python -m build |
20 |
| -twine check --strict dist/* && twine upload --repository-url https://test.pypi.org/legacy/ dist/* |
21 |
| -``` |
| 12 | + - [ ] Click "Choose a tag" |
22 | 13 |
|
23 |
| -- [ ] (Optional) Check **test** installation: |
| 14 | + - [ ] Type the next `vX.Y.Z` version and select "**Create new tag: vX.Y.Z** on |
| 15 | + publish" |
24 | 16 |
|
25 |
| -```bash |
26 |
| -python -m pip uninstall -y stravavis |
27 |
| -python -m pip install -U -i https://test.pypi.org/simple/ stravavis |
28 |
| -stravavis --help |
29 |
| -``` |
| 17 | + - [ ] Leave the "Release title" blank (it will be autofilled) |
30 | 18 |
|
31 |
| -- [ ] Tag with the version number: |
| 19 | + - [ ] Click "Generate release notes" and amend as required |
32 | 20 |
|
33 |
| -```bash |
34 |
| -git tag -a v0.0.1 -m "Release 0.0.1" |
35 |
| -``` |
| 21 | + - [ ] Click "Publish release" |
36 | 22 |
|
37 |
| -- [ ] Create a distribution and release on **live PyPI**: |
38 |
| - |
39 |
| -```bash |
40 |
| -python -m pip install -U pip build keyring twine |
41 |
| -rm -rf build dist |
42 |
| -python -m build |
43 |
| -twine check --strict dist/* && twine upload -r pypi dist/* |
44 |
| -``` |
| 23 | +- [ ] Check the tagged |
| 24 | + [GitHub Actions build](https://github.com/marcusvolz/strava_py/actions/workflows/deploy.yml) |
| 25 | + has deployed to [PyPI](https://pypi.org/project/stravavis/#history) |
45 | 26 |
|
46 | 27 | - [ ] Check installation:
|
47 | 28 |
|
48 | 29 | ```bash
|
49 |
| -python -m pip uninstall -y stravavis |
50 |
| -python -m pip install -U stravavis |
51 |
| -stravavis --help |
| 30 | +pip3 uninstall -y stravavis && pip3 install -U stravavis && stravavis --help |
52 | 31 | ```
|
53 |
| - |
54 |
| -- [ ] Push tag: |
55 |
| - |
56 |
| -```bash |
57 |
| -git push --tags |
58 |
| -``` |
59 |
| - |
60 |
| -- [ ] Create a new release: https://github.com/marcusvolz/strava_py/releases/new |
61 |
| - |
62 |
| -- [ ] Click "Choose a tag" and select newest. |
63 |
| - |
64 |
| -- [ ] Click "Auto-generate release notes", amend as required and "Publish release". |
0 commit comments