summaryrefslogtreecommitdiff
path: root/RELEASING.md
blob: 43abf88af13fea8cc565414bbb7989d97f2a2acc (plain)
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
# Releasing Parley

1. Update the version in `pyproject.toml`, `parley/__init__.py`, and the Arch
   `PKGBUILD`; update `CHANGELOG.md`.
2. Run the release checks:

   ```bash
   python -m unittest discover -s tests
   ruff check parley tests
   ruff format --check parley tests
   bash -n scripts/* packaging/arch/PKGBUILD
   node --check extension/extension.js
   gnome-extensions pack --force --out-dir=/tmp extension
   ```

3. Manually test recording, cancellation, clipboard fallback, IBus insertion,
   the in-field spinner, daemon restart, shortcut, and Shell extension in a
   fresh GNOME session.
4. Commit the release and create an annotated tag:

   ```bash
   git tag -a v1.0.0 -m "Parley 1.0.0"
   git push origin main v1.0.0
   ```

5. Build and install `packaging/arch/PKGBUILD` after the tag is available from
   GitHub. Repeat the smoke test using only packaged files.
6. Create the GitHub release from `CHANGELOG.md` and attach the Arch package if
   desired.