Fix and validate Compose quick start

The list-form environment syntax in the README passed quote characters
through as part of the value, so LIBRARY_ID was read as '"<id>"' and no
matching library was found. Switch to mapping syntax, where YAML strips
the quotes.

- Pin the example to a versioned image instead of implicit latest
- Add a checked-in compose.example.yaml
- Validate it with `docker compose config` in CI
- Link the Docker Hub image from the README
This commit is contained in:
Maxim Shulga committed 2026-08-02 14:53:08 -07:00
1 parent a7abdab1f7
commit d500ddc7ab
4 files changed
+231 -7

No files matched your search

+3
View File
@@ -16,6 +16,9 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Validate compose example
run: docker compose --file compose.example.yaml config --quiet
- name: Run tests
run: |
if [ -f docker-compose.test.yml ]; then