YAML Migration

[sreelakshmi-bruno]

Hi everyone,

Starting with Bruno v3.1.0, new and imported collections will be stored in the YAML file format.

If you’d like to migrate an existing collection, you can do so by exporting it and then re-importing it. In upcoming releases, we’ll introduce a more seamless, automated migration option. If you run into any issues or have questions during migration, please use this thread to discuss them.

If you already have collections in the .bru format, nothing will break. We’ll continue to maintain full feature parity, and both formats will remain fully supported.

This change does not affect your workflows or how you use Bruno; it only updates the underlying file format used to store requests. Read more about it in this blog. Thanks!

[clarkritchie]

I am trying to standardize how to maintain a large number of collections, environments and secrets and have a question..

What is now most canonical way to codify environments and secrets now? BRU, JSON and YAML are all supported -- but YAML seems like what to standardize on.

Environments seem pretty straightforward.

/foo/my-collection/environments/foo.yaml

name: foo-env
variables:
  - name: ENVIRONMENT_URI
    value: www.foo.com

/foo/my-collection/environments/bar.yaml

name: bar-env
variables:
  - name: ENVIRONMENT_URI
    value: www.bar.com

ENVIRONMENT_URI can then be used in my YAML collection as:

info:
  name: status
  type: http
  seq: 2

http:
  method: GET
  url: https://{{ENVIRONMENT_URI}}/status
  ...

If I need secrets, I can do:

http:
  method: GET
  url: https://{{ENVIRONMENT_URI}}/baz
  headers:
    - name: Accept
      value: application/json
  auth:
    type: oauth2
    ...
    credentials:
      clientId: "{{process.env.CLIENT_ID}}"
      clientSecret: "{{process.env.CLIENT_ID_SECRET}}"

Where CLIENT_ID and CLIENT_ID_SECRET are in /foo/my-collection/.env.

Then, when I switch from testing in foo-env to testing in bar-env, if the later uses different credentials then maybe I need to manually drop a different .env into place?

[fantpmas]

Small issue but if you reference .bru files like this, the .bru file extension is not replaced so it will fail: await bru.runRequest("Setup/Populate user ids.bru"). Would be nice if it converted this automatically to await bru.runRequest("Setup/Populate user ids.yml")