feat: add audit api spec to pr workflow #7480
Merged
+496
−3
Conversation
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
danielzhao122
force-pushed
the
WP-6702-add-audit-api-specs-to-ci
branch
from
e8f02f2 to
d1bfac5
Compare
zahin-mohammad
approved these changes
Nov 11, 2025
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.
This PR adds automated API specification auditing as a GitHub Actions workflow that runs on every pull request. Previously, we only audited the API spec during releases, which meant API specification errors could be merged into the codebase and only discovered later in the release process.
Since the actual
audit-api-specworkflow from dev-portal requires a vault token, we've implemented our own workflow that mimics the actual audit process used in dev-portal without the need of the token.The new workflow:
@api-ts/openapi-generator@v5vacuum v0.18.1(same version as dev-portal)ruleset.yamlused indev-portalTest run that shows the
audit-api-specsjob fails when it detects errors: https://github.com/BitGo/BitGoJS/actions/runs/19271735416/job/55101534330?pr=7480