mirror of
https://github.com/usebruno/bruno.git
synced 2026-07-08 14:35:03 +00:00
f916b19a6f
* feat(cli): add Docker Compose example for the Bruno CLI Docker image * Update packages/bruno-cli/docker/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * refactor(docker-compose): move docker-compose.yml outside the collection folder Keeps packages/bruno-tests/collection/ as pure Bruno collection content (bruno.json, .bru files, environments). The docker-compose example now sits one level up and mounts ./collection into the container, so the collection stays portable. * docs(cli): omit --rm from docker examples, add note explaining when to use it Command examples in docker/README.md no longer suggest --rm by default so users can docker logs / docker inspect the stopped container after a run. A note panel under Step 3 explains what --rm does and when to opt in (CI hygiene, avoiding stopped-container buildup). The version-check command in Step 2 keeps --rm since it is a one-shot sanity probe. Alpine and Debian sub-READMEs follow the same policy; the explanatory note lives only in the main docker/README.md. * feat(bruno-tests): wire docker-compose to emit JSON, JUnit, HTML reports via mounted reports/ dir * docs(cli): apply PR review feedback — rephrase step 3 intro, use latest image tag, use placeholder collection path * docs(cli): apply EM review — trim bru-only steps, generalize options note, dedupe tag table, consolidate gitignore * docs(cli): minor README polish in docker docs (add --rm to CI example, simplify collection path placeholder) * docs(cli): drop --env staging from generic examples, pin CI snippets to :latest, reposition --rm note * docs: updated Readme.md --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
23 lines
986 B
Markdown
23 lines
986 B
Markdown
# Bruno CLI — Docker run reports
|
|
|
|
This folder is the bind-mount target for the Docker Compose example at [`../docker-compose.yml`](../docker-compose.yml).
|
|
|
|
When you run:
|
|
|
|
```bash
|
|
cd packages/bruno-tests
|
|
docker compose run bruno-cli
|
|
```
|
|
|
|
the container writes three report files into this directory:
|
|
|
|
| File | Format | Purpose |
|
|
|------|--------|---------|
|
|
| `results.json` | JSON | Machine-readable run summary (request/response, timings, assertion results) |
|
|
| `results.xml` | JUnit XML | For CI test reporters (GitHub Actions, GitLab CI, Jenkins, etc.) |
|
|
| `results.html` | HTML | Human-readable report you can open in a browser |
|
|
|
|
The files themselves are gitignored — only this `README.md` and the `.gitignore` are tracked, which keeps the folder present in the repo so the `./reports:/reports` bind mount has somewhere to land without needing manual `mkdir` first.
|
|
|
|
To skip a format, drop the corresponding `--reporter-*` flag from the `command:` block in `docker-compose.yml`.
|