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

Automated recipe validation #9

Open
kittsville opened this issue Apr 15, 2018 · 2 comments
Open

Automated recipe validation #9

kittsville opened this issue Apr 15, 2018 · 2 comments
Labels
enhancement New feature or request

Comments

@kittsville
Copy link
Contributor

As part of recipe quality assurance (QA) we will likely have various standards for how recipes should be formatted. This might mean capitalisation in certain places or ending method steps with a full stop. This validation could be added as a step to ingestion, after JSON ingestion and before loading into the database.

Simplest implementation could be a single function that takes a recipe and either:

  • Does nothing
  • Prints a warning
  • Fails the build

Depending on the severity of the issue.

@kittsville kittsville added the enhancement New feature or request label Apr 15, 2018
@kittsville kittsville changed the title Autmated recipe validation Automated recipe validation Apr 15, 2018
@kittsville
Copy link
Contributor Author

We have since moved from JSON recipes to Scala, which greatly reduces the possibility of errors. Further validation could be added using refined types: https://github.com/fthomas/refined

@kittsville
Copy link
Contributor Author

Easier option is just using require

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant