Skip to content

Update docs upon changes to Bruno: migrate-to-YML pill and drafts #166

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update docs upon changes to Bruno: migrate-to-YML pill and drafts #166

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
21 changes: 21 additions & 0 deletions opencollection-yaml/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
Since everything is stored in standard YAML, you can leverage the entire ecosystem of existing tools:

- **IDE support** — Native syntax highlighting in VS Code, JetBrains IDEs, Vim, and virtually any editor without additional extensions
- **Linting & validation** — Use tools like `yamllint`, `prettier`, or custom JSON Schema validators

Check warning on line 30 in opencollection-yaml/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

opencollection-yaml/overview.mdx#L30 

Did you really mean 'validators'?
- **Git integration** — GitHub, GitLab, and Bitbucket provide built-in YAML syntax highlighting and diff views for pull requests
- **Scripting & automation** — Parse and manipulate collections with standard YAML libraries in any programming language (Python, Node.js, Go, etc.)
- **CI/CD pipelines** — Easily integrate with existing pipeline tools that already understand YAML
Expand Down Expand Up @@ -160,6 +160,27 @@

Bruno supports both `.bru` and `.yml` formats, so you can migrate your collections gradually. Both formats can coexist within the same collection during the transition period.

### Migrate a collection with the header pill

Bruno shows a **Migrate to YML** pill in the collection header for collections that are still stored in `.bru` format. Click the pill to open the migration modal, or dismiss it with the **X** to hide the prompt for that collection. Dismissals are remembered per collection.

The migration modal converts all files in the collection:

- Request files change from `.bru` to `.yml`.
- Environment files are rewritten in YAML.
- `bruno.json` is replaced with `opencollection.yml`.

Open tabs for the collection close and the collection reloads once the migration finishes.

### Unsaved changes

If any drafts exist when you start the migration, the modal switches to an **Unsaved changes** step that lists up to five affected items across the collection, folders, requests, and collection environments. Resolve the drafts before Bruno migrates the files:

- **Save all** writes every draft to disk in one batch, then starts the migration automatically.
- **Discard all** drops the pending changes, then starts the migration.

Transient requests (requests that have never been saved to disk) can't be batch-saved. Save each one manually from the modal so the migration can continue.


## Resources

Expand Down
Loading