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

Create a YAML schema file to plan out our changes to our yaml spec #4058

Closed
3 tasks done
agjohnson opened this issue May 3, 2018 · 3 comments
Closed
3 tasks done
Assignees
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Needed: design decision A core team decision is required
Milestone

Comments

@agjohnson
Copy link
Contributor

agjohnson commented May 3, 2018

I raised in #3878 a good way to start our YAML spec changes would be to write a schema:

I think the next step is to start writing a schema and some actual examples. https://github.com/23andMe/Yamale looks promising.

We should start here so that we can formalize the tree structure and naming conventions, and provide some validation checks.

Work required here might be:

  • Start writing a schema file
  • Start review early, or separate this work into two PRs
  • Add tests around validation of our schema and some example schema fixture files. This won't necessarily replace the need for logic unit tests similar to the build repo now
@agjohnson agjohnson added Improvement Minor improvement to code Needed: design decision A core team decision is required labels May 3, 2018
@agjohnson agjohnson added this to the 2.5 milestone May 3, 2018
@stsewd
Copy link
Member

stsewd commented May 4, 2018

I was looking at https://json-schema-everywhere.github.io/yaml, seems like more standard, but there is only a js implementation :(, I'll try to see if the library is mature enough, maybe we can use it doing external calls.

@agjohnson
Copy link
Contributor Author

I'd be -1 on using a javascript solution here. A python module gives us the ability to quickly turn the schema into unit tests.

@agjohnson agjohnson added the Accepted Accepted issue on our roadmap label Jun 8, 2018
@agjohnson
Copy link
Contributor Author

The underlying PR was just merged. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants