Skip to content

docs: say that compose/ is a published interface, and what on-push diffs from #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goldyfruit merged 1 commit into from
Sep 11, 2026
Merged

docs: say that compose/ is a published interface, and what on-push diffs from #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ All Python images share `ovos-base` (Debian slim, Python 3.13, a virtual environ
pinned [uv](https://github.com/astral-sh/uv)). Each image has a `HEALTHCHECK`, an SBOM, a
provenance attestation, and a cosign signature.

The compose files under `compose/` are consumed by other projects, not only by people: the
[OVOS installer](https://github.com/OpenVoiceOS/ovos-installer) clones this repository at a
release tag and runs them. The compose file names, the container names, the environment
variables the compose reads and the images it pulls are therefore a published interface, and
`contract.yml` declares all four. Run `scripts/contract.py --write` after editing `compose/`;
CI fails when the declaration and the compose files disagree.

## Talking to OVOS from a terminal

The `ovos-cli` image ships [ovos-tui-client](https://github.com/andlo/ovos-tui-client),
Expand Down Expand Up @@ -128,7 +135,7 @@ multi-arch manifest lists. The workflows are in `.github/workflows/`:

| Workflow | Trigger | What it builds |
|---|---|---|
| `on-push.yml` | A commit on `dev` | The targets whose build context changed, plus the targets built on top of them, for `alpha`, `testing`, and `stable` |
| `on-push.yml` | A commit on `dev` | The targets whose build context changed since the last commit this workflow published, plus the targets built on top of them, for `alpha`, `testing`, and `stable` |
| `on-constraints.yml` | A `repository_dispatch` from ovos-releases, an hourly poll, or a manual run | For each channel, the images that contain a package whose `constraints-<channel>.txt` line changed since the last build |
| `pull-request.yml` | A pull request | The affected targets, for both architectures, without a push |
| `scheduled-rebuild.yml` | Once a week | Every image of a channel |
Expand Down
2 changes: 1 addition & 1 deletion README_MACOS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ PulseAudio may use a different audio output (sink) than the one actually used by

## How to use these images

Please refer to [this section](README.md#how-to-use-these-images) of the documentation.
Please refer to [this section](README.md#run-images) of the documentation.

## Thanks

Expand Down
2 changes: 1 addition & 1 deletion README_WINDOWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Time per period = 3.278807

## How to use these images

Please refer to [this section](README.md#how-to-use-these-images) of the documentation.
Please refer to [this section](README.md#run-images) of the documentation.

## Thanks

Expand Down