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

ci(json-schema-check): improve readibility and output helpful debug info #285

Merged
merged 2 commits into from
Feb 21, 2024

Conversation

xmfcx
Copy link
Contributor

@xmfcx xmfcx commented Feb 20, 2024

Description

  • This PR makes it easier to find the source of errors in the checks.
  • Also makes it more clear on what exact files are checked against which exact schemas.
  • Also converts the bash one-liner to a python script for maintainability.

Tests performed

Temporarily created a tag named vTempTestJson to test it from Universe.

Before

Screenshot from 2024-02-21 02-39-21

After

Screenshot from 2024-02-21 02-38-49

Effects on system behavior

Colorful outputs!

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@xmfcx xmfcx force-pushed the ci/json-schema-better-output branch 5 times, most recently from 3ec742c to cf43e18 Compare February 20, 2024 23:11
@xmfcx xmfcx force-pushed the ci/json-schema-better-output branch from 31849a1 to 3c39cb0 Compare February 20, 2024 23:31
@xmfcx xmfcx marked this pull request as ready for review February 20, 2024 23:42
@xmfcx
Copy link
Contributor Author

xmfcx commented Feb 20, 2024

Sorry @VRichardJP for tagging you, I saw the name Vincent in the git blame and added you. But it was Ambroise Vincent :D

@xmfcx xmfcx removed the request for review from VRichardJP February 20, 2024 23:58
@xmfcx xmfcx self-assigned this Feb 21, 2024
@xmfcx
Copy link
Contributor Author

xmfcx commented Feb 21, 2024

@ambroise-arm this is ready for review 🙇

Copy link
Contributor

@ambroise-arm ambroise-arm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks much better than my minimal implementation!

json-schema-check/validate_json_schemas.py Outdated Show resolved Hide resolved
Signed-off-by: M. Fatih Cırıt <[email protected]>
@xmfcx xmfcx merged commit 39f6110 into main Feb 21, 2024
14 of 15 checks passed
@xmfcx xmfcx deleted the ci/json-schema-better-output branch February 21, 2024 12:17
@xmfcx
Copy link
Contributor Author

xmfcx commented Feb 21, 2024

Thank you for the prompt review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants