Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ichiro-its/ros2-ws-action
Setup, build and test a ROS 2 workspace using GitHub Actions
https://github.com/ichiro-its/ros2-ws-action
actions build github-actions ros ros2 test testing
Last synced: 21 days ago
JSON representation
Setup, build and test a ROS 2 workspace using GitHub Actions
- Host: GitHub
- URL: https://github.com/ichiro-its/ros2-ws-action
- Owner: ichiro-its
- License: mit
- Created: 2021-05-21T16:40:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T10:19:19.000Z (4 months ago)
- Last Synced: 2024-11-15T22:14:41.986Z (about 2 months ago)
- Topics: actions, build, github-actions, ros, ros2, test, testing
- Homepage: https://github.com/marketplace/actions/ros-2-workspace-action
- Size: 75.2 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ROS 2 Workspace Action
[](https://github.com/ichiro-its/ros2-ws-action/releases/)
[](./LICENSE)
[](https://github.com/ichiro-its/ros2-ws-action/actions/workflows/test.yaml)
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 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 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 Workspace Action:
| Name | Default | Description |
| --- | --- | --- |
| `distro` | `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 Workspace Action to build and test a ROS 2 workspace in your GitHub Actions workflow:
```yaml
name: ROS 2 CI
on:
push:
jobs:
build-and-test:
name: Build and Test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/[email protected]
with:
path: workspace
- name: Build and test workspace
uses: ichiro-its/[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.
#### Specifying ROS 2 Distribution
You can specify the ROS 2 distribution to be used by providing it as an input parameter:
```yaml
- name: Build and test workspace
uses: ichiro-its/[email protected]
with:
distro: rolling
```
#### Running Individual Setup, Build, and Test Steps
You can use the `setup`, `build`, and `test` sub-actions to run each action individually for the setup, build, and test steps:
```yaml
- name: Setup workspace
uses: ichiro-its/ros2-ws-action/[email protected]
- name: Build workspace
uses: ichiro-its/ros2-ws-action/[email protected]
- name: Test workspace
uses: ichiro-its/ros2-ws-action/[email protected]
```
## License
This project is licensed under the terms of the [MIT License](./LICENSE).
Copyright © 2021-2023 [ICHIRO ITS](https://github.com/ichiro-its)