-
Notifications
You must be signed in to change notification settings - Fork 673
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
refactor(json-schema): align schema and config file names #5798
refactor(json-schema): align schema and config file names #5798
Conversation
@ambroise-arm Different nodes may be created with partially matching names (e.g. So, I suggest using a slash that cannot be used in nodes as a separator. In other words, create a directory with the node name like below.
|
Ah yes, indeed. I agree that it will not work if nodes have names that partially match. And your suggestion looks good to me. However, it would imply a change touching every single package in autoware.universe. I suppose it would need to be discussed and agreed first. I am not planning to do that in this PR. I think the change I introduce here is strictly better than the current design, as it would allow to unblock #4902 while introducing no regression to the packages that have already implemented a schema file. |
@ambroise-arm OK. We will discuss the issue of partially matching names separately. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM (mission_planner package)
c035e50
to
b5a15bb
Compare
@miursh @scepter914 Please review when you have time |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5798 +/- ##
=======================================
Coverage 15.25% 15.25%
=======================================
Files 1750 1750
Lines 120562 120562
Branches 36735 36735
=======================================
Hits 18390 18390
Misses 81543 81543
Partials 20629 20629
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM (radar_object_fusion_to_detected_object)
The schema files need to follow a NODE_NAME.schema.json naming convention and the configuration files need to follow a NODE_NAME*.param.yaml naming convention. It allows to have one schema file per node in a package. Rename files that didn't match this pattern. Signed-off-by: Ambroise Vincent <[email protected]>
b5a15bb
to
1bbb4f5
Compare
…undation#5798) The schema files need to follow a NODE_NAME.schema.json naming convention and the configuration files need to follow a NODE_NAME*.param.yaml naming convention. It allows to have one schema file per node in a package. Rename files that didn't match this pattern. Signed-off-by: Ambroise Vincent <[email protected]>
…undation#5798) The schema files need to follow a NODE_NAME.schema.json naming convention and the configuration files need to follow a NODE_NAME*.param.yaml naming convention. It allows to have one schema file per node in a package. Rename files that didn't match this pattern. Signed-off-by: Ambroise Vincent <[email protected]>
…undation#5798) The schema files need to follow a NODE_NAME.schema.json naming convention and the configuration files need to follow a NODE_NAME*.param.yaml naming convention. It allows to have one schema file per node in a package. Rename files that didn't match this pattern. Signed-off-by: Ambroise Vincent <[email protected]>
…undation#5798) The schema files need to follow a NODE_NAME.schema.json naming convention and the configuration files need to follow a NODE_NAME*.param.yaml naming convention. It allows to have one schema file per node in a package. Rename files that didn't match this pattern. Signed-off-by: Ambroise Vincent <[email protected]>
Description
The current paths of the schema/config files need to be changed slightly to account for a limitation in the current design where a package can't have more than one schema file (otherwise the CI fails). The update to the design is described in autowarefoundation/autoware-github-actions#232 (comment)
The schema files need to follow a NODE_NAME.schema.json naming convention and the configuration files need to follow a NODE_NAME*.param.yaml naming convention. It allows to have one schema file per node in a package.
Rename files that didn't match this pattern.
Related links
Align the autoware.universe codebase with #5289
After this PR is merged, autowarefoundation/autoware-github-actions#263 can be moved out of draft
This will probably unblock #4902
Tests performed
Verified the configurations files renamed were not referred to in other autoware.universe packages.
Only CI tests were run
Notes for reviewers
Interface changes
Changed the paths of some .schema.json and .param.yaml files.
Effects on system behavior
None
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.
After all checkboxes are checked, anyone who has write access can merge the PR.