summaryrefslogtreecommitdiff
path: root/RELEASING.md
diff options
context:
space:
mode:
Diffstat (limited to 'RELEASING.md')
-rw-r--r--RELEASING.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..43abf88
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,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.