Skip to content

Conversation

@Ishan1923
Copy link

@Ishan1923 Ishan1923 commented Aug 16, 2025

Closes #86

This pull request migrates the work order description files from JSON to YAML format, as proposed in issue #86.

GenAI Use

We follow OSRA's policy on GenAI tools

  • I used a GenAI tool in this PR.
  • I did not use GenAI

Generated-by: Gemini 2.5 pro

@Ishan1923 Ishan1923 force-pushed the JSON2YAML branch 2 times, most recently from d795558 to 2ec1f03 Compare August 16, 2025 21:23
Copy link
Collaborator

@aaronchongth aaronchongth left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! Please also update the tests in https://github.com/osrf/nexus/tree/main/nexus_demos, which intakes the work orders

There is some flakiness in our integration testing CI at the moment, which is being looked into #115. You can run the tests locally too, by sourcing the workspace, navigating to the nexus_demos repository, and running RMW_IMPLEMENTATION=rmw_cyclonedds_cpp python3 -m unittest

Updated demo tests, configs, and dependencies to handle YAML format as per review.
@Ishan1923
Copy link
Author

Hi @aaronchongth,

Apologies for the delay in getting these updates to you, and thanks again for the detailed review.

I have now pushed the latest changes addressing all your feedback. Here is a quick summary of the work done:

  • The test scripts in nexus_demos have been updated to use and parse the new .yaml work order files.
  • python3-yaml has been added as a dependency to the nexus_demos package.xml.
  • The EOF nitpicks in the three .yaml config files have been corrected.
  • The filename reference in the disabled test file (test_parallel_pick_and_place_rmf.py.disabled) has been fixed.

The CI checks should all be passing now. Could you please take another look when you have a moment?

Best,
Ishan

Copy link
Collaborator

@aaronchongth aaronchongth left a comment

Choose a reason for hiding this comment

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

Thanks for the changes, I have left a few more comments.

We have not made the necessary changes to the github repository template yet, but could you also declare in your PR description if Generative AI tools were used for this PR, per OSRA policy https://discourse.openrobotics.org/t/osrf-adopts-policy-on-use-of-generative-ai-in-contributions/43685, and if so, what tool.

You can add and fill up this block

### GenAI Use
We follow [OSRA's policy on GenAI tools](https://github.com/openrobotics/osrf-policies-and-procedures/blob/main/OSRF%20Policy%20on%20the%20Use%20of%20Generative%20Tools%20(%E2%80%9CGenerative%20AI%E2%80%9D)%20in%20Contributions.md)

- [ ] I used a GenAI tool in this PR.
- [ ] I did not use GenAI

Generated-by:

Comment on lines 14 to 15
state: "state_1"

No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
state: "state_1"
state: "state_1"

EOF lines cannot have white spaces

Comment on lines 8 to 9
state: "state_1"

No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
state: "state_1"
state: "state_1"

EOF lines cannot have white spaces

Comment on lines 8 to 9
state: "state_1"

No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
state: "state_1"
state: "state_1"

EOF lines cannot have white spaces

<test_depend>ament_index_cpp</test_depend>
<test_depend>rcpputils</test_depend>

<!-- json2yaml edit -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove stale comment

@Ishan1923
Copy link
Author

Hi @aaronchongth,

I've just pushed the latest updates addressing your feedback. The stale comments and extra whitespace have been removed from the YAML files, and I've also added the GenAI declaration to the pull request description.

Could you please take another look when you have a moment?

Thanks!

@Ishan1923 Ishan1923 requested a review from aaronchongth August 29, 2025 19:54
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.

Switch to YAML for work order files

2 participants