Skip to content
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.

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

Implement GitHub Action to Validate examples Field in Schemas #217

Closed
KhudaDad414 opened this issue Nov 1, 2023 · 6 comments
Closed

Implement GitHub Action to Validate examples Field in Schemas #217

KhudaDad414 opened this issue Nov 1, 2023 · 6 comments
Labels
area/ci-cd Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. enhancement New feature or request good first issue Good for newcomers

Comments

@KhudaDad414
Copy link
Member

Background/Context

In the current state, nearly all schemas within our bindings include an examples field. Automating the validation of these examples against their respective schemas can serve as a proactive measure to identify incorrect or incomplete schemas.

Objective

Implement a GitHub Action that automates the validation of the examples field in modified or newly added .json schemas. This action should be triggered at the Pull Request level to ensure the integrity of changes before they are merged.

Requirements

  1. Trigger: The GitHub Action should run whenever a Pull Request is created or updated.
  2. Scope: Only .json files that have been modified or added in the PR should be considered for validation.
  3. Feedback: If validation fails, the action should comment on the PR indicating which files have issues.
@KhudaDad414 KhudaDad414 added the enhancement New feature or request label Nov 1, 2023
@asyncapi asyncapi deleted a comment from asyncapi-bot Nov 1, 2023
@KhudaDad414
Copy link
Member Author

/gfi ci-cd

@asyncapi-bot asyncapi-bot added area/ci-cd Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. good first issue Good for newcomers labels Nov 1, 2023
@Gmin2
Copy link

Gmin2 commented Dec 27, 2023

@KhudaDad414 We need to create the action in a new file and not on existing yml file right?

@KhudaDad414
Copy link
Member Author

@Min2who yes exactly, we need a new workflow.

@Gmin2
Copy link

Gmin2 commented Dec 28, 2023

ok working in it

@Gmin2
Copy link

Gmin2 commented Jan 21, 2024

this issue should be closed here and should be reopened in the spec-json-schemas repo as this #183 remove all json schemas to spec-json-schemas

@KhudaDad414
Copy link
Member Author

@Min2who you are right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci-cd Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants