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.

Sign up for GitHub

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

Jump to bottom

Validate scenarios against schema as part of CI #1428

Closed
byorgey opened this issue Aug 13, 2023 · 1 comment · Fixed by #1475
Closed

Validate scenarios against schema as part of CI #1428

byorgey opened this issue Aug 13, 2023 · 1 comment · Fixed by #1475
Assignees
@kostmo
Labels
Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. Z-Documentation This issue is about README or Wikis or Haddock or...

Comments

@byorgey
Copy link
Member

byorgey commented Aug 13, 2023 •
edited
Loading

Yeah, I don't think we have been keeping it up to date, I know @kostmo has added a bunch of features that I think we missed adding to the schema. If there is an automated way to make sure all existing scenario descriptions conform to the schema, we should add it to our CI!

Originally posted by @byorgey in #1376 (comment)
@byorgey
Copy link
Member Author

byorgey commented Aug 13, 2023

https://github.com/python-jsonschema/check-jsonschema may be useful.

@kostmo kostmo added Z-Documentation This issue is about README or Wikis or Haddock or... Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. labels Aug 21, 2023
@kostmo kostmo mentioned this issue Aug 21, 2023
Closed
@kostmo kostmo self-assigned this Aug 26, 2023
@kostmo kostmo mentioned this issue Aug 27, 2023
Merged
@mergify mergify bot closed this as completed in #1475 Aug 28, 2023
mergify bot pushed a commit that referenced this issue Aug 28, 2023
@kostmo
Validate scenarios against json schema (#1475)
bfc0c14 
Closes #1428

Since the authoritative validation of scenario files is actually performed by virtue of `swarm` parsing them, this CI job actually exists to ensure the JSON Schema descriptions are accurate.  This is important for two purposes:
* Documentation is generated from the JSON Schema files (#1436)
* JSON Schema has integration with VS Code and other IDEs

# Testing

Verified that the schema checker action does indeed work by intentionally pushing an invalid scenario file in f789f81.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kostmo kostmo

Labels
Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. Z-Documentation This issue is about README or Wikis or Haddock or...
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Validate scenarios against json schema swarm-game/swarm
2 participants
@kostmo @byorgey