chore(mise): provision API docs for the project's libraries #23

Merged
lucas merged 1 commit from agent/issue-21-doc-packages into main 2026-11-13 14:07:07 +01:00
Collaborator

Adds the -doc packages matching the -dev packages already declared in [bootstrap.packages], so the APIs the code consumes (wp/*, pipewire/keys.h, glib.h, RtMidi.h, ALSA) can be read locally instead of guessed.

Package names and versions exist in Debian trixie alongside the declared -dev packages. No libspa-0.2-dev entry: libpipewire-0.3-dev already depends on it. Only the tracked mise.toml is touched; mise.local.toml is left alone.

Verification — mise bootstrap status from the repository root lists all five new entries alongside the pre-existing ones:

packages  apt:libmagicenum-dev                   missing
packages  apt:wireplumber-doc                    missing
packages  apt:libglib2.0-doc                     missing
packages  apt:pipewire-doc                       missing
packages  apt:librtmidi-doc                      missing
packages  apt:libasound2-doc                     missing

Installing the packages is out of scope.

Closes: #21

Adds the `-doc` packages matching the `-dev` packages already declared in `[bootstrap.packages]`, so the APIs the code consumes (`wp/*`, `pipewire/keys.h`, `glib.h`, `RtMidi.h`, ALSA) can be read locally instead of guessed. Package names and versions exist in Debian trixie alongside the declared `-dev` packages. No `libspa-0.2-dev` entry: `libpipewire-0.3-dev` already depends on it. Only the tracked `mise.toml` is touched; `mise.local.toml` is left alone. Verification — `mise bootstrap status` from the repository root lists all five new entries alongside the pre-existing ones: ``` packages apt:libmagicenum-dev missing packages apt:wireplumber-doc missing packages apt:libglib2.0-doc missing packages apt:pipewire-doc missing packages apt:librtmidi-doc missing packages apt:libasound2-doc missing ``` Installing the packages is out of scope. Closes: #21
chore(mise): provision API docs for the project's libraries
All checks were successful
Build / build (pull_request) Successful in 39s
d00736610f
The bootstrap config declares a -dev package for every library the code
includes, so the headers are available locally but their API
documentation is not. Add the matching -doc packages for WirePlumber,
GLib, PipeWire, RtMidi and ALSA so the APIs can be read offline in a
development environment provisioned from this repository.

Co-Authored-By: Claude Opus 5 via omp-deck
lucas merged commit 530bd777ae into main 2026-11-13 14:07:07 +01:00
lucas deleted branch agent/issue-21-doc-packages 2026-11-13 14:07:08 +01:00
Author
Collaborator

The red Build / build (push) check on the merge commit 530bd777ae041662a64195eb7254beca641f5ff7 is not a failure of this change, and I have not opened a follow-up pull request because there is nothing in the tree to fix.

Run #19 was cancelled 17s in, mid-apt-get install, with ⚙️ [runner]: context canceled — no step failed. It was superseded by the push of 2669dcd (merge of #22) landing seconds later: the same runner picked that run up 1.4s after #19 was cancelled, and it finished green through Configure/Build/Test.

This change only touches mise.toml; the workflow installs its dependencies with explicit apt-get and never reads that file, so it cannot influence the build. 530bd77 is an ancestor of main, the tip 2669dcd carries all five -doc entries, and its checks are green.

Filed #26 with the full evidence and the maintainer decision it leaves open (leave as is, add a concurrency group, or re-run #19 to clean the history).

The red `Build / build (push)` check on the merge commit `530bd777ae041662a64195eb7254beca641f5ff7` is not a failure of this change, and I have not opened a follow-up pull request because there is nothing in the tree to fix. Run #19 was cancelled 17s in, mid-`apt-get install`, with `⚙️ [runner]: context canceled` — no step failed. It was superseded by the push of `2669dcd` (merge of #22) landing seconds later: the same runner picked that run up 1.4s after #19 was cancelled, and it finished green through Configure/Build/Test. This change only touches `mise.toml`; the workflow installs its dependencies with explicit `apt-get` and never reads that file, so it cannot influence the build. `530bd77` is an ancestor of `main`, the tip `2669dcd` carries all five `-doc` entries, and its checks are green. Filed #26 with the full evidence and the maintainer decision it leaves open (leave as is, add a `concurrency` group, or re-run #19 to clean the history).
Sign in to join this conversation.
No reviewers
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
lucas/nanoKontroller2!23
No description provided.