feat: rename ros2-distro Input to distro (#41)

* feat: rename `ros2-distro` input to be `distro` * chore: update the correct commit hash for the sub-actions
ichiro-its · Nov 3, 2023 · 609df52 · 609df52
1 parent 2ab635c
commit 609df52
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ros2-distro: [humble, iron]
+        distro: [humble, iron]
     steps:
       - name: Checkout this repository
         uses: actions/[email protected]
@@ -20,7 +20,7 @@ jobs:
         uses: actions/[email protected]
         with:
           repository: ros2/examples
-          ref: ${{ matrix.ros2-distro }}
+          ref: ${{ matrix.distro }}
           path: examples
           sparse-checkout: |
             rclcpp/topics
@@ -29,20 +29,20 @@ jobs:
       - name: Setup workspace
         uses: ./setup
         with:
-          ros2-distro: ${{ matrix.ros2-distro }}
+          distro: ${{ matrix.distro }}
 
       - name: Build workspace
         uses: ./build
         with:
-          ros2-distro: ${{ matrix.ros2-distro }}
+          distro: ${{ matrix.distro }}
 
   setup-build-test:
     name: Setup, Build, and Test
     runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
-        ros2-distro: [humble, iron]
+        distro: [humble, iron]
     steps:
       - name: Checkout this repository
         uses: actions/[email protected]
@@ -51,7 +51,7 @@ jobs:
         uses: actions/[email protected]
         with:
           repository: ros2/examples
-          ref: ${{ matrix.ros2-distro }}
+          ref: ${{ matrix.distro }}
           path: examples
           sparse-checkout: |
             rclcpp/topics
@@ -60,4 +60,4 @@ jobs:
       - name: Test the action
         uses: ./
         with:
-          ros2-distro: ${{ matrix.ros2-distro }}
+          distro: ${{ matrix.distro }}
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ Here are the available input parameters for the ROS 2 Build and Test Workspace A
 
 | Name | Default | Description |
 | --- | --- | --- |
-| `ros2-distro` | `iron` | Specify the version of ROS 2 to be set up using this action. You can refer to the [ROS 2 Distributions](https://docs.ros.org/en/rolling/Releases.html) for information about the available distributions to be used. |
+| `ros2` | `iron` | Specify the distribution of ROS 2 to be set up using this action. You can refer to the [ROS 2 Distributions](https://docs.ros.org/en/rolling/Releases.html) for information about the available distributions to be used. |
 
 ### Examples
 
@@ -59,7 +59,7 @@ You can specify the ROS 2 distribution to be used by providing it as an input pa
 - name: Build and test
   uses: ichiro-its/[email protected]
   with:
-    ros2-distro: rolling
+    distro: rolling
 ```
 
 ## License

diff --git a/action.yml b/action.yml
@@ -5,18 +5,18 @@ branding:
   icon: activity
   color: gray-dark
 inputs:
-  ros2-distro:
-    description: The ROS 2 distribution to be used.
+  distro:
+    description: The ROS 2 distribution to be used
     required: false
     default: iron
 runs:
   using: composite
   steps:
-    - uses: ichiro-its/ros2-build-and-test-action/setup@d80e4254f5c4722b0dcea1b73b83d434a2db069c
+    - uses: ichiro-its/ros2-build-and-test-action/setup@18f8d40805c2668f07b836763824d99bb6e33f9b
       with:
-        ros2-distro: ${{ inputs.ros2-distro }}
+        distro: ${{ inputs.distro }}
 
-    - uses: ichiro-its/ros2-build-and-test-action/build@d80e4254f5c4722b0dcea1b73b83d434a2db069c
+    - uses: ichiro-its/ros2-build-and-test-action/build@18f8d40805c2668f07b836763824d99bb6e33f9b
 
     - shell: bash
       run: |

diff --git a/setup/action.yaml b/setup/action.yaml
@@ -5,8 +5,8 @@ branding:
   icon: activity
   color: gray-dark
 inputs:
-  ros2-distro:
-    description: The ROS 2 distribution to be used.
+  distro:
+    description: The ROS 2 distribution to be used
     required: false
     default: iron
 runs:
@@ -26,9 +26,9 @@ runs:
       run: |
         sudo rosdep init
         rosdep update
-        rosdep install -y --rosdistro ${{ inputs.ros2-distro }} --from-paths .
+        rosdep install -y --rosdistro ${{ inputs.distro }} --from-paths .
 
     - shell: bash
       run: |
-        source /opt/ros/${{ inputs.ros2-distro }}/setup.bash
+        source /opt/ros/${{ inputs.distro }}/setup.bash
         colcon build --packages-skip-regex '.*'