{"id":22735309,"url":"https://github.com/ichiro-its/ros2-ws-action","last_synced_at":"2025-04-14T03:07:03.989Z","repository":{"id":48801344,"uuid":"369597024","full_name":"ichiro-its/ros2-ws-action","owner":"ichiro-its","description":"Setup, build and test a ROS 2 workspace using GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-09-12T10:19:19.000Z","size":77,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T03:06:55.531Z","etag":null,"topics":["actions","build","github-actions","ros","ros2","test","testing"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/ros-2-workspace-action","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ichiro-its.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-21T16:40:27.000Z","updated_at":"2024-05-17T04:14:34.000Z","dependencies_parsed_at":"2022-08-25T05:22:46.367Z","dependency_job_id":"730a507c-cbca-4995-99b9-9b47ef9d5b4f","html_url":"https://github.com/ichiro-its/ros2-ws-action","commit_stats":null,"previous_names":["ichiro-its/ros2-ws-action","ichiro-its/ros2-build-and-test-action"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ichiro-its%2Fros2-ws-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ichiro-its%2Fros2-ws-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ichiro-its%2Fros2-ws-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ichiro-its%2Fros2-ws-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ichiro-its","download_url":"https://codeload.github.com/ichiro-its/ros2-ws-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248813795,"owners_count":21165633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","build","github-actions","ros","ros2","test","testing"],"created_at":"2024-12-10T21:08:56.943Z","updated_at":"2025-04-14T03:07:03.966Z","avatar_url":"https://github.com/ichiro-its.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# ROS 2 Workspace Action\n\n[![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/)\n[![license](https://img.shields.io/github/license/ichiro-its/ros2-ws-action?style=flat-square)](./LICENSE)\n[![test status](https://img.shields.io/github/actions/workflow/status/ichiro-its/ros2-ws-action/test.yaml?label=test\u0026branch=main\u0026style=flat-square)](https://github.com/ichiro-its/ros2-ws-action/actions/workflows/test.yaml)\n\nThe 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.\nThis 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).\n\n## Key Features\n\nThe ROS 2 Workspace Action offers the following key features:\n\n- **Automated ROS 2 Distribution Setup:** Automatically sets up a specified ROS 2 distribution.\n- **Dependency Management:** Automatically installs dependencies required for each package.\n- **Efficient Building and Testing:** Utilizes colcon for streamlined building and testing of each package.\n\n## Usage\n\nTo 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.\n\n### Inputs\n\nHere are the available input parameters for the ROS 2 Workspace Action:\n\n| Name | Default | Description |\n| --- | --- | --- |\n| `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. |\n\n### Examples\n\nHere 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:\n\n```yaml\nname: ROS 2 CI\non:\n  push:\njobs:\n  build-and-test:\n    name: Build and Test\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4.1.6\n        with:\n          path: workspace\n\n      - name: Build and test workspace\n        uses: ichiro-its/ros2-ws-action@v1.0.0\n```\n\n\u003e 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.\n\n#### Specifying ROS 2 Distribution\n\nYou can specify the ROS 2 distribution to be used by providing it as an input parameter:\n\n```yaml\n- name: Build and test workspace\n  uses: ichiro-its/ros2-ws-action@v1.0.0\n  with:\n    distro: rolling\n```\n\n#### Running Individual Setup, Build, and Test Steps\n\nYou can use the `setup`, `build`, and `test` sub-actions to run each action individually for the setup, build, and test steps:\n\n```yaml\n- name: Setup workspace\n  uses: ichiro-its/ros2-ws-action/setup@v1.0.0\n\n- name: Build workspace\n  uses: ichiro-its/ros2-ws-action/build@v1.0.0\n\n- name: Test workspace\n  uses: ichiro-its/ros2-ws-action/test@v1.0.0\n```\n\n## License\n\nThis project is licensed under the terms of the [MIT License](./LICENSE).\n\nCopyright © 2021-2023 [ICHIRO ITS](https://github.com/ichiro-its)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fichiro-its%2Fros2-ws-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fichiro-its%2Fros2-ws-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fichiro-its%2Fros2-ws-action/lists"}