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

feat: validate JSON configuration before generating build #167

Merged
merged 1 commit into from
Apr 14, 2021

Conversation

ghost
Copy link

@ghost ghost commented Apr 14, 2021

Adds UCC config validation against a predefined JSON schema.

Reason: improve developer experience while creating add on for Splunk. This change should avoid unnecessary builds if config is not correct. For example, error when specifying too long label currently is only visible after installing a TA in Splunk which takes time. This change makes it visible immediately.

Other improvements to consider in the future:

  • fail validation if an input contains unsupported option (i.e. "blackList", which was changed to "denyList")
  • test case for correct and incorrect configurations

cc: @ricardom-splunk

@github-actions
Copy link

github-actions bot commented Apr 14, 2021

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@github-actions
Copy link

Expected release notes (by @arys-splunk)

features:
validate JSON configuration before generating build (ab2e1ba)

others (will not be included in Semantic-Release notes):
d4993e9 updated to use schma.product rather than schema.namespace (#166)

  • I hereby acknowledge these release notes are 🥙 AWESOME 🥙

@ghost
Copy link
Author

ghost commented Apr 14, 2021

I have read the CLA Document and I hereby sign the CLA

@ryanfaircloth ryanfaircloth merged commit 0c80d62 into main Apr 14, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Apr 14, 2021
@ryanfaircloth
Copy link
Contributor

🎉 This PR is included in version 4.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@ghost ghost deleted the feature/schema-validation branch April 15, 2021 12:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants