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

add submission schema and tools to generate it (New) #770

Merged
merged 8 commits into from
Dec 1, 2023

Conversation

kissiel
Copy link
Contributor

@kissiel kissiel commented Oct 19, 2023

Description

This PR introduces the schema of submission.json that's uploaded to C3 from Checkbox.
Alongside there's an instruction on how to generate that.

Resolved issues

Resolves: https://warthogs.atlassian.net/browse/CHECKBOX-927

@kissiel kissiel changed the title add submission schema and tools to generate it add submission schema and tools to generate it (New) Oct 19, 2023
submission-schema/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@mz2 mz2 left a comment

Choose a reason for hiding this comment

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

I'd prefer dropping the genson instructions and build script dependent on it, since I'd prefer we relied on quicktype which is a very commonly used tool for the purpose (that it's slower just makes me think it does something more thoroughly 🙂 ).

submission-schema/README.md Show resolved Hide resolved
submission-schema/README.md Outdated Show resolved Hide resolved
submission-schema/README.md Outdated Show resolved Hide resolved
submission-schema/build_schema.py Outdated Show resolved Hide resolved
submission-schema/README.md Show resolved Hide resolved
@mz2 mz2 requested a review from Hook25 November 21, 2023 10:31
Copy link
Collaborator

@Hook25 Hook25 left a comment

Choose a reason for hiding this comment

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

Lets keep one way to do this: quicktype.

How was the schema.json file generated in this PR? Did we use genson or quicktype? If we used genson please double check that the result is the same. Also, the build_schema.py script should be updated to reflect this tool change (if we still need it)

@kissiel
Copy link
Contributor Author

kissiel commented Nov 29, 2023

I'll rerun the checks with submissions I used.

@kissiel
Copy link
Contributor Author

kissiel commented Nov 30, 2023

The one in the PR is the genson one.
I'm attaching the one generated with QT.
schema-qt.json

@mz2
Copy link
Collaborator

mz2 commented Nov 30, 2023

Schema replaced, genson instructions dropped. Please review ASAP.

Copy link
Collaborator

@Hook25 Hook25 left a comment

Choose a reason for hiding this comment

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

Few changes to get this landed

.github/workflows/daily-builds.yml Outdated Show resolved Hide resolved
submission-schema/README.md Outdated Show resolved Hide resolved
submission-schema/build_schema.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@Hook25 Hook25 left a comment

Choose a reason for hiding this comment

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

+1, tyvm

Copy link
Collaborator

@mz2 mz2 left a comment

Choose a reason for hiding this comment

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

Looks ready now, thanks for putting this together @kissiel and for the help @Hook25

@mz2 mz2 enabled auto-merge (squash) December 1, 2023 12:49
@mz2 mz2 merged commit c0b1634 into main Dec 1, 2023
4 checks passed
@mz2 mz2 deleted the submission-json-schema branch December 1, 2023 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants