[GPCAPIM-323] Keep Bruno collection in sync #170
Open
davidhamill1-nhs wants to merge 19 commits intomainfrom
Open
[GPCAPIM-323] Keep Bruno collection in sync #170davidhamill1-nhs wants to merge 19 commits intomainfrom
davidhamill1-nhs wants to merge 19 commits intomainfrom
Conversation
…-add-bruno-cli-to-pipeline' into feature/GPCAPIM-323-add-bruno-cli-to-pipeline
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the Steel Thread Bruno collection from legacy .bru/bruno.json files to OpenCollection YAML format and adds a GitHub Actions workflow to run the collection in CI to keep it in sync.
Changes:
- Converted the Steel_Thread collection and environments from
.bruformat to OpenCollection YAML (opencollection.yml, request.yml, environment.yml). - Removed legacy Bruno files (
collection.bru,*.bruenv/request files,bruno.json). - Added a PR-triggered GitHub Actions workflow to run Bruno against the local app and publish reports.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| bruno/gateway-api/collections/Steel_Thread/opencollection.yml | Adds OpenCollection collection metadata, default headers, and OAuth2 auth configuration. |
| bruno/gateway-api/collections/Steel_Thread/environments/PR_Proxy.yml | Adds YAML environment for PR proxy base URL composition. |
| bruno/gateway-api/collections/Steel_Thread/environments/PR_Proxy.bru | Removes legacy Bruno environment format. |
| bruno/gateway-api/collections/Steel_Thread/environments/local.yml | Adds YAML environment for local base URL. |
| bruno/gateway-api/collections/Steel_Thread/environments/local.bru | Removes legacy Bruno environment format. |
| bruno/gateway-api/collections/Steel_Thread/collection.bru | Removes legacy collection-level headers/auth/vars. |
| bruno/gateway-api/collections/Steel_Thread/bruno.json | Removes legacy Bruno collection metadata file. |
| bruno/gateway-api/collections/Steel_Thread/Access_Structured_Record.yml | Adds YAML request definition for $gpc.getstructuredrecord. |
| bruno/gateway-api/collections/Steel_Thread/Access_Structured_Record.bru | Removes legacy request format. |
| .github/workflows/test-bruno-collection.yaml | Adds CI workflow to start the app and run the Bruno collection with report publishing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bruno/gateway-api/collections/Steel_Thread/Access_Structured_Record.yml
Outdated
Show resolved
Hide resolved
bruno/gateway-api/collections/Steel_Thread/Access_Structured_Record.yml
Outdated
Show resolved
Hide resolved
…ee app for testing
|
|
Deployment Complete
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a new test step that executes the collections against the Preview Env.
I have also moved Bruno files to the opencollection specification that they promote and support.
The place where the workflow runs will probably change with @neil-sproston 's work on GitHub Actions, GPCAPIM-339.
Context
Bruno CLI (https://docs.usebruno.com/bru-cli/overview) + Brunos unlimited executions of collections can be leveraged so that our manual API test collections stay in sync with the API at the point changes are made (ie in the PR pipeline).
Once this change has been made any changes to the API that havent been applied in the Bruno API test collections will cause pipeline failures and prevent PR merge - forcing the dev/test to maintain them and therefore keep them true to the API
Type of changes
Checklist
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.