Skip to content

Commit 025fe8f

Browse files
committed
docs: validation update / contributing updates
1 parent d595f20 commit 025fe8f

3 files changed

Lines changed: 36 additions & 6 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,20 @@ and has not been verified, and against which libei versions, is in
9292

9393
## Releasing
9494

95-
Versions are SemVer and live in two places — `pyproject.toml` and
96-
`src/libei/__init__.py` — which have to agree with each other and with the
97-
tag. Nothing enforces that yet.
95+
Versions are SemVer and live in four places. Each one is checked rather than
96+
trusted, so a bump that misses one fails somewhere instead of shipping:
97+
98+
- `pyproject.toml` — what pip and the built artifacts use.
99+
- `src/libei/__init__.py` — what a caller introspects, held to
100+
`pyproject.toml` by
101+
`tests/test_documentation_shape.py::test_version_is_declared_identically_in_both_places`.
102+
- `README.md` and `docs/developers/verification.md` — both state it in prose,
103+
and `test_status_pages_name_the_current_version` fails if either stops
104+
naming the current one.
105+
- **The release tag.** CI's `build` job reads the version back out of the
106+
built sdist — not out of the source — and fails the tag push when the two
107+
disagree, so a PyPI number is never spent on a tag describing a different
108+
tree.
98109

99110
A release is an annotated, `v`-prefixed tag. Pushing it is the whole of it;
100111
PyPI is the only place a release is published, and no GitHub Release is cut:

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# python-libei
22

3+
[![Contributing](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/ctrondlp/python-libei/blob/main/CONTRIBUTING.md)
34
[![CI](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml)
45
[![PyPI](https://img.shields.io/pypi/v/python-libei)](https://pypi.org/project/python-libei/)
56
[![License](https://img.shields.io/pypi/l/python-libei)](https://github.com/ctrondlp/python-libei/blob/main/LICENSE)

‎docs/developers/verification.md‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,31 @@ By hand:
3737
relative pointer, keyboard, absolute pointer, in that order, which is the
3838
device race `ei`-side callers must handle; and `Session.Close()` was
3939
exercised. No input was injected — emulation is `libei.ei`'s job.
40-
- **`libei.portal.InputCaptureSession` (added 0.5.0), negotiation half only**,
40+
- **`libei.portal.InputCaptureSession` (added 0.5.0), the v1 half**,
4141
2026-09-08, against a real Fedora 44 / GNOME Shell 50.0 session
4242
(xdg-desktop-portal 1.21.1). That portal reports InputCapture **version 0**,
4343
so this exercised the **v1 `CreateSession` path**: consent dialog approved,
4444
a real EIS fd returned, `zones()` answering `(0, [(1920, 1080, 0, 0)])`, and
45-
`Session.Close()` exercised. The v2 `CreateSession2` -> `Start` path has
46-
still never been run live.
45+
`Session.Close()` exercised.
46+
47+
- **The v2 half, `CreateSession2` -> `Start`**, 2026-10-04, against a real
48+
Fedora 45 / GNOME Shell 51.0 session (xdg-desktop-portal 1.22.1,
49+
xdg-desktop-portal-gnome 51.0, libei 1.6.0, Python 3.15rc2). That portal
50+
reports InputCapture **version 2**, so the version gate sent this run down
51+
the half the 2026-09-08 one could not reach -- and v1 is not reachable there
52+
at all any more, which makes the two dates a pair rather than a repeat. Every
53+
call was driven live, in order: `CreateSession2` (0.03s -- a plain call, with
54+
the session existing before anything is asked), `Start` (12.94s -- the
55+
consent dialog, approved), `ConnectToEIS` (0.10s -- a real EIS fd; `fstat`
56+
reports a socket), `GetZones` (0.06s, answering `(0, [(1920, 974, 0, 0)])`)
57+
and `Session.Close` (0.03s): 13.07s end to end. Nothing was captured, and
58+
nothing could have been -- the run stopped at negotiation, and by the shipped
59+
spec it is `Enable` that arms capture, not `Start`.
60+
61+
So both negotiation routes have now been run against a real compositor. Two
62+
things remain untested live on this route: persistence, since `persist_mode`
63+
and the `restore_token` `Start` returns are v2 additions this run did not
64+
use -- and the capture half itself.
4765

4866
**The capture half remains unverified**, and unlike the rest of
4967
`libei.portal` its consent dialog is not the whole reason why. Approving a

0 commit comments

Comments
 (0)