Skip to content

Commit 2a378e1

Browse files
bdbarnettclaude
andcommitted
Dedupe secrets block; consolidate LVGL family paragraph; add docs/README.md
docs/publishing.md's "Repository Secrets" section restated TESTPYPI_API_TOKEN ownership verbatim from the org-wide runbook now at dotgithub/docs/publishing-automation.md. Replaced it with a link — the runbook is canonical and covers all the secrets this repo's release flow needs (TESTPYPI_API_TOKEN, RELEASE_WORKFLOW_TOKEN). Replaced the duplicated "LVGL family" positioning paragraph in README.md with a link to the new canonical section in lvgl-bindings/README.md#the-lvgl-family. Added docs/README.md — this repo's docs/ dir had no curated index. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 10419c4 commit 2a378e1

3 files changed

Lines changed: 18 additions & 7 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Native CPython extension for [LVGL](https://lvgl.io/), generated from [`lvgl-bindings`](https://github.com/PyDevices/lvgl-bindings) with **no MicroPython runtime**.
44

5-
This is the publishing endpoint in the LVGL family: lvgl-bindings owns the upstream binding tags, and this repo turns those updates into versioned `pydevices-lvgl` wheels on TestPyPI. The CircuitPython and MicroPython consumer repos rebuild from the synced bindings rather than publishing their own packages.
5+
This is the publishing endpoint in the LVGL family: it turns synced bindings into versioned `pydevices-lvgl` wheels on TestPyPI. See [lvgl-bindings — The LVGL family](https://github.com/PyDevices/lvgl-bindings#the-lvgl-family) for how the family fits together.
66

77
> **Pip name:** `pydevices-lvgl` · **Import:** `import lvgl as lv`
88

docs/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# lvgl-python documentation
2+
3+
- [building.md](building.md) — local build/dev workflow, syncing generated
4+
bindings from lvgl-bindings.
5+
- [publishing.md](publishing.md) — how a bindings change becomes a versioned
6+
`pydevices-lvgl` wheel on TestPyPI, and how to install it. Secrets/credential
7+
ownership lives in the org-wide runbook,
8+
[dotgithub/docs/publishing-automation.md](https://github.com/PyDevices/dotgithub/blob/main/docs/publishing-automation.md)
9+
linked from here rather than duplicated.
10+
11+
See the [root README](../README.md) for how this repo fits into the
12+
[LVGL family](https://github.com/PyDevices/lvgl-bindings#the-lvgl-family).

docs/publishing.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,11 @@ Preview the next version:
5757

5858
### Repository Secrets
5959

60-
Requires repository authentication secrets for uploading wheels to TestPyPI and dispatching automatic release workflows across repositories.
61-
62-
- `TESTPYPI_API_TOKEN`: token owned by `bdbarnett` while the PyDevices
63-
TestPyPI organization request is pending.
64-
65-
Settings → Secrets and variables → Actions on repository.
60+
Required secrets, their ownership, and how TestPyPI token auth is wired into the upload action
61+
are documented org-wide in
62+
[dotgithub/docs/publishing-automation.md — Automation and credentials](https://github.com/PyDevices/dotgithub/blob/main/docs/publishing-automation.md#automation-and-credentials).
63+
This repo needs `TESTPYPI_API_TOKEN` (and `RELEASE_WORKFLOW_TOKEN` for the cross-repo LVGL sync
64+
trigger); do not restate their ownership here.
6665

6766
## Automatic release (recommended)
6867

0 commit comments

Comments
 (0)