1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# Release Procedure
In the commands below, replace `X.Y.Z` with the release version when needed.
**Note**: We use `pip` instead of `conda` here even on Conda installs, to ensure we always get the latest upstream versions of the build dependencies.
## PyPI
To release a new version of QtPy on PyPI:
### Prepare
* Close [GitHub milestone](https://github.com/spyder-ide/qtpy/milestones) and ensure all issues are resolved/moved
* Update local repo
```bash
git restore . && git switch master && git pull upstream master
```
* Clean local repo
```bash
git clean -xfdi
```
### Commit
* Install/upgrade Loghub
```bash
pip install --upgrade loghub
```
* Update `CHANGELOG.md` using Loghub to generate the list of issues and PRs merged to add at the top of the file
```bash
loghub -m vX.Y.Z spyder-ide/qtpy
```
* Update `__version__` in `__init__.py` (set release version, remove `.dev0`)
* Create release commit
```bash
git commit -am "Release X.Y.Z"
```
### Build
* Update the packaging stack
```bash
python -m pip install --upgrade pip
pip install --upgrade --upgrade-strategy eager build setuptools twine wheel
```
* Build source distribution and wheel
```bash
python -bb -X dev -W error -m build
```
* Check distribution archives
```bash
twine check --strict dist/*
```
### Release
* Upload distribution packages to PyPI
```bash
twine upload dist/*
```
* Create release tag
```bash
git tag -a vX.Y.Z -m "Release X.Y.Z"
```
### Finalize
* Update `__version__` in `__init__.py` (add `.dev0` and increment minor)
* Create `Back to work` commit
```bash
git commit -am "Back to work"
```
* Push new release commits and tags to `master`
```bash
git push upstream master --follow-tags
```
* Create a [GitHub release](https://github.com/spyder-ide/qtpy/releases) from the tag
## Conda-Forge
To release a new version of QtPy on Conda-Forge:
* After the release on PyPI, an automatic PR in the [Conda-Forge feedstock repo for QtPy](https://github.com/conda-forge/qtpy-feedstock/pulls) should open.
Merging this PR will update the respective Conda-Forge package.
|
