CICD: Add GitHub Actions workflow for OpenAPI syntax validation #482
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
Open
7 tasks
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.
Issue Reference : Fixes #366
Description: This pull request introduces a GitHub Actions workflow to validate the OpenAPI syntax of the following files:
meta.yamlregistry.yamltransaction.yamlThe workflow ensures that:
Key Changes:
Added openapi-validation.yml to define the validation process.
Utilized
@redocly/openapi-clifor OpenAPI 3.0 validation.Testing:
The workflow runs automatically on pull requests and validates the specified files. If any syntax errors are found, the workflow will fail, preventing the PR from being merged until the errors are resolved.
Impact:
This ensures that the master branch remains free of OpenAPI syntax errors, improving the reliability of the specifications.