Ros2 use branch name

[pawelirh]

Changes

• Add new input to build the docker image workflow
• Parametrize the panther_ros branch in both Dockerfiles

Summary by CodeRabbit

• New Features

  • Introduced a new input parameter, panther_codebase_version, for enhanced configurability in the Docker image workflow.
  • Added a new build argument, BRANCH_NAME, to support dynamic branch specification during the Docker build process for both hardware and simulation Dockerfiles.

• Updates

  • Updated the Docker image action to a newer version, potentially improving the build process.
  • Enhanced the maintainability of Dockerfiles by replacing hardcoded branch names with the new BRANCH_NAME argument.

[coderabbitai]

Walkthrough

The pull request introduces modifications to a GitHub Actions workflow and Dockerfiles for building and publishing a ROS Docker image. A new input parameter, panther_codebase_version, is added to the workflow, allowing users to specify the version of panther_ros. The Docker image action is updated to a newer version, and the branch name is dynamically set using the panther_codebase_version. Additionally, both Dockerfile.hardware and Dockerfile.simulation now include a build argument BRANCH_NAME, enhancing flexibility in branch specification during the build process.

Changes

File	Change Summary
.github/workflows/ros-docker-image.yaml	- Added panther_codebase_version input. - Updated action from husarion-ci/ros-docker-img-action@v0.5 to @v0.6. - Modified branch_name to use panther_codebase_version.
Dockerfile.hardware, Dockerfile.simulation	- Added ARG BRANCH_NAME=ros2-devel. - Moved ARG BUILD_TEST=OFF (no functional change). - Updated git clone to use BRANCH_NAME.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c2c5860 and 98cffa2.

Files selected for processing (3)

• .github/workflows/ros-docker-image.yaml (2 hunks)
• Dockerfile.hardware (2 hunks)
• Dockerfile.simulation (2 hunks)

Additional comments not posted (7)

Dockerfile.simulation (2)

5-6: LGTM!

The addition of the BRANCH_NAME build argument with a default value of ros2-devel provides flexibility to specify the branch at build time. The change in the order of the BUILD_TEST argument does not affect the functionality.

---

18-18: LGTM!

Using the BRANCH_NAME argument in the git clone command ensures that the specified branch is cloned. This change improves maintainability and adaptability of the Dockerfile for different development scenarios.

Dockerfile.hardware (2)

5-6: LGTM!

The addition of the BRANCH_NAME build argument with a default value of ros2-devel enhances the flexibility of the Dockerfile by allowing the branch name to be specified during the build process. This change aligns with the PR objective of parameterizing the branch name.

The change in position of the BUILD_TEST argument has no functional impact and is acceptable.

---

18-18: LGTM!

Updating the Git clone command to use the BRANCH_NAME build argument instead of hardcoding the branch name is a positive change. It improves maintainability by centralizing the branch specification and aligns with the PR objective of parameterizing the branch name.

.github/workflows/ros-docker-image.yaml (3)

7-11: LGTM!

The addition of the panther_codebase_version input is a great enhancement to the workflow configurability. It allows users to specify the version of panther_ros to be used in the Docker image, which aligns perfectly with the PR objectives.

---

63-63: LGTM!

Updating the branch_name input to utilize the panther_codebase_version input is a great way to ensure that the specified version is passed correctly during the build process. This change aligns perfectly with the addition of the new input and enhances the configurability of the workflow.

---

56-56: LGTM, but verify compatibility.

Updating the Docker image action to a newer version (v0.6) is a good practice to leverage potential enhancements and bug fixes. However, it's crucial to ensure that the newer version is compatible with the workflow and doesn't introduce any breaking changes.

Run the following script to verify compatibility:

Verification successful

---

Update to Docker image action version v0.6 is compatible.

The release notes for version v0.6 do not indicate any breaking changes or compatibility issues. The addition of the branch_name optional parameter should not affect existing workflows unless it is explicitly used.

• The update to version v0.6 is safe and compatible with the current setup.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify compatibility of the updated Docker image action version.

# Test: Search for any compatibility issues or breaking changes in the changelog or release notes of the action. Expect: No breaking changes or compatibility issues.
gh api /repos/husarion-ci/ros-docker-img-action/releases | jq -r '.[0].body' | rg -i 'breaking|compatibility'

Length of output: 111

---

Script:

#!/bin/bash
# Description: List all releases and their notes for manual verification of compatibility issues.

# Fetch all releases and their notes from the GitHub repository.
gh api /repos/husarion-ci/ros-docker-img-action/releases | jq -r '.[] | "Version: \(.tag_name)\nNotes: \(.body)\n---"'

Length of output: 610

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.