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

Check message definition updates automatically #1204

Merged
merged 5 commits into from
Feb 29, 2024

Conversation

f0reachARR
Copy link
Contributor

Description

Abstract

This PR will add some Actions workflow to track updates of ROS 2 message definition(msgs) files.

Background

When msgs changes, we sometimes need to modify simulator to adopt these changes.
The change could not be known until someone on the team noticed.
Therefore, This PR will establish a workflow for automatic notification of changes.

Details

  • Add Python scripts to notify changes by following procedure.
    1. Scan all source code to extract all used msgs.
    2. Check recent updates of msgs by git log command
    3. Post it to automated issues Message dependencies update tracker #1203
  • Add workflow to run the script every Monday.

Destructive Changes

None

Known Limitations

The script does not scan ROS 2 official msgs. It will scan autoware msgs.

Copy link

github-actions bot commented Feb 29, 2024

Checklist for reviewers ☑️

All references to "You" in the following text refer to the code reviewer.

  • Is this pull request written in a way that is easy to read from a third-party perspective?
  • Is there sufficient information (background, purpose, specification, algorithm description, list of disruptive changes, and migration guide) in the description of this pull request?
  • If this pull request contains a destructive change, does this pull request contain the migration guide?
  • Labels of this pull request are valid?
  • All unit tests/integration tests are included in this pull request? If you think adding test cases is unnecessary, please describe why and cross out this line.
    No test is needed because this pull-request includes only file changes related to workflow.
  • The documentation for this pull request is enough? If you think adding documents for this pull request is unnecessary, please describe why and cross out this line.

@f0reachARR f0reachARR changed the title Ci/check message update Check message definition updates automatically Feb 29, 2024
@f0reachARR f0reachARR self-assigned this Feb 29, 2024
@HansRobo HansRobo added the bump patch If this pull request merged, bump patch version of the scenario_simulator_v2 label Feb 29, 2024
@f0reachARR f0reachARR marked this pull request as ready for review February 29, 2024 06:27
@hakuturu583
Copy link
Collaborator

Please add dependency of python script to the pyproject.toml

@f0reachARR
Copy link
Contributor Author

I forgot that this project uses Poetry. I fixed pyproject.toml and workflow

@f0reachARR
Copy link
Contributor Author

I will check this workflow by act. Please merge after my check.

@f0reachARR
Copy link
Contributor Author

OK, I checked this workflow works

@f0reachARR f0reachARR requested a review from HansRobo February 29, 2024 08:52
Copy link
Member

@HansRobo HansRobo left a comment

Choose a reason for hiding this comment

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

LGTM.
@f0reachARR Thanks a lot!

@HansRobo HansRobo merged commit f5e0bc0 into master Feb 29, 2024
9 checks passed
@HansRobo HansRobo deleted the ci/check-message-update branch February 29, 2024 09:08
@github-actions github-actions bot restored the ci/check-message-update branch February 29, 2024 09:08
@github-actions github-actions bot deleted the ci/check-message-update branch February 29, 2024 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump patch If this pull request merged, bump patch version of the scenario_simulator_v2 small feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants