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

ci(json-schema-check): allow nested config paths #294

Merged

Conversation

amadeuszsz
Copy link
Contributor

@amadeuszsz amadeuszsz commented May 21, 2024

Description

Currently, json-schema-check considers only specific files match: schema/<schema_cfg_name>.schema.json and config/<schema_cfg_name>.param.yaml. For packages with many config files, the config directory structure may differ. Even though the files follow naming convention, the sub directories are not taken into account. This small change in pull request adds following naming convention: schema/<schema_cfg_name>.schema.json and config/<namespace>/<schema_cfg_name>.param.yaml.

Tests performed

Checked locally with CI script few test cases, success stands for Validating ... and fail stands for No configuration files found for schema ... or schema was not found.

  1. Expected success.
<package_name>
      |
      |—— schema
      |     |—— <schema_cfg_name>.schema.json
      |
      |—— config
      |     |—— <schema_cfg_name>.param.yaml
      |

Current: ${\color{green}SUCCESS}$
Proposed: ${\color{green}SUCCESS}$

  1. Expected success.
<package_name>
      |
      |—— schema
      |     |—— <schema_cfg_name>.schema.json
      |
      |—— config
      |     |—— <namespace>
      |              |
      |              |—— <schema_cfg_name>.param.yaml
      |

Current: ${\color{red}FAIL}$
Proposed: ${\color{green}SUCCESS}$

Effects on system behavior

Not applicable.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@drwnz drwnz self-requested a review May 24, 2024 01:40
Copy link

@drwnz drwnz left a comment

Choose a reason for hiding this comment

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

LGTM

@mitsudome-r mitsudome-r merged commit 3796c20 into autowarefoundation:main May 24, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants