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

Rename the Project to "ROS 2 Workspace Action" #42

Merged
merged 2 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# ROS 2 Build and Test Workspace Action
# ROS 2 Workspace Action

[![latest version](https://img.shields.io/github/v/release/ichiro-its/ros2-build-and-test-action?style=flat-square)](https://github.com/ichiro-its/ros2-build-and-test-action/releases/)
[![license](https://img.shields.io/github/license/ichiro-its/ros2-build-and-test-action?style=flat-square)](./LICENSE)
[![test status](https://img.shields.io/github/actions/workflow/status/ichiro-its/ros2-build-and-test-action/test.yaml?label=test&branch=main&style=flat-square)](https://github.com/ichiro-its/ros2-build-and-test-action/actions/workflows/test.yaml)
[![latest version](https://img.shields.io/github/v/release/ichiro-its/ros2-ws-action?style=flat-square)](https://github.com/ichiro-its/ros2-ws-action/releases/)
[![license](https://img.shields.io/github/license/ichiro-its/ros2-ws-action?style=flat-square)](./LICENSE)
[![test status](https://img.shields.io/github/actions/workflow/status/ichiro-its/ros2-ws-action/test.yaml?label=test&branch=main&style=flat-square)](https://github.com/ichiro-its/ros2-ws-action/actions/workflows/test.yaml)

The ROS 2 Build and Test Workspace Action is a [GitHub Action](https://github.com/features/actions) designed to build and test a [ROS 2](https://www.ros.org/) workspace containing multiple packages.
The ROS 2 Workspace Action is a [GitHub Action](https://github.com/features/actions) designed to setup, build and test a [ROS 2](https://www.ros.org/) workspace containing multiple packages.
This action automatically sets up ROS 2 and other dependencies used in each package, and then proceeds to build and test them all using [colcon](https://colcon.readthedocs.io/en/released/user/quick-start.html).

## Key Features

The ROS 2 Build and Test Workspace Action offers the following key features:
The ROS 2 Workspace Action offers the following key features:

- **Automated ROS 2 Distribution Setup:** Automatically sets up a specified ROS 2 distribution.
- **Dependency Management:** Automatically installs dependencies required for each package.
- **Efficient Building and Testing:** Utilizes colcon for streamlined building and testing of each package.

## Usage

To get started with the ROS 2 Build and Test Workspace Action, you can refer to the [action.yaml](./action.yaml) file for detailed configuration options. Additionally, if you are new to GitHub Actions, you can explore the [GitHub Actions guide](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) for a comprehensive overview.
To get started with the ROS 2 Workspace Action, you can refer to the [action.yaml](./action.yaml) file for detailed configuration options. Additionally, if you are new to GitHub Actions, you can explore the [GitHub Actions guide](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) for a comprehensive overview.

### Inputs

Here are the available input parameters for the ROS 2 Build and Test Workspace Action:
Here are the available input parameters for the ROS 2 Workspace Action:

| Name | Default | Description |
| --- | --- | --- |
| `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

Here is the basic example of how to use the ROS 2 Build and Test Workspace Action to build and test a ROS 2 workspace in your GitHub Actions workflow:
Here is the basic example of how to use the ROS 2 Workspace Action to build and test a ROS 2 workspace in your GitHub Actions workflow:

```yaml
name: ROS 2 CI
Expand All @@ -46,7 +46,7 @@ jobs:
path: workspace

- name: Build and test
uses: ichiro-its/ros2-build-and-test[email protected]
uses: ichiro-its/ros2-ws[email protected]
```

> It is recommended not to checkout the repository in the root directory. Otherwise, tests may fail because the package's files could be mixed with the build result.
Expand All @@ -57,7 +57,7 @@ You can specify the ROS 2 distribution to be used by providing it as an input pa

```yaml
- name: Build and test
uses: ichiro-its/ros2-build-and-test[email protected]
uses: ichiro-its/ros2-ws[email protected]
with:
distro: rolling
```
Expand Down
8 changes: 4 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: ROS 2 Build and Test Workspace
description: Build and test a ROS 2 workspace from source
name: ROS 2 Workspace Action
description: Setup, build and test a ROS 2 workspace from source
author: ICHIRO ITS
branding:
icon: activity
Expand All @@ -12,11 +12,11 @@ inputs:
runs:
using: composite
steps:
- uses: ichiro-its/ros2-build-and-test-action/setup@18f8d40805c2668f07b836763824d99bb6e33f9b
- uses: ichiro-its/ros2-ws-action/setup@18f8d40805c2668f07b836763824d99bb6e33f9b
with:
distro: ${{ inputs.distro }}

- uses: ichiro-its/ros2-build-and-test-action/build@18f8d40805c2668f07b836763824d99bb6e33f9b
- uses: ichiro-its/ros2-ws-action/build@18f8d40805c2668f07b836763824d99bb6e33f9b

- shell: bash
run: |
Expand Down
Loading