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

feat: setup files validation #10

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: setup files validation #10

wants to merge 6 commits into from

Conversation

davidcavazos
Copy link
Collaborator

@davidcavazos davidcavazos commented Feb 21, 2025 •
edited
Loading

This adds validation to ci-setup.json files. The following checks are done:

  • Returns all validation errors for all setup files
  • Check that fields are defined by the defaults
  • Check the type of the fields
  • Allows "comment fields" if it starts with an underscore
  • Clear and actionable error messages
  • Optionally define a URL to redirect for more information

@davidcavazos davidcavazos requested a review from a team as a code owner February 21, 2025 21:05
briandorsey
briandorsey approved these changes Feb 21, 2025
View reviewed changes
Copy link
Member

@briandorsey briandorsey left a comment

Choose a reason for hiding this comment

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

Yea! LGTM. Several nits & thoughts, feel free to take or ignore any of them.

ariwete/pkg/config/config_test.go
@@ -264,3 +265,104 @@ func TestFindSetupFiles(t *testing.T) {
t.Fatal("expected equal\n", expected, "\n", got)
}
}
func TestFindSetupFilesWithValidation(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

praise: love the detailed test cases!

@briandorsey
Copy link
Member

Thanks for adding the support for showing multiple validation errors in one run!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@briandorsey briandorsey briandorsey approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@davidcavazos @briandorsey