Skip to content

Commit

Permalink
docs: update Examples section of the readme file (#45)
Browse files Browse the repository at this point in the history
* docs: add "Running Individual Setup, Build, and Test Steps" section in the example

* docs: adjust step name in the example
  • Loading branch information
threeal authored Nov 3, 2023
1 parent e9b116b commit 6d1affc
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
with:
path: workspace

- name: Build and test
- name: Build and test workspace
uses: ichiro-its/[email protected]
```
Expand All @@ -56,12 +56,27 @@ jobs:
You can specify the ROS 2 distribution to be used by providing it as an input parameter:
```yaml
- name: Build and test
- 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).
Expand Down

0 comments on commit 6d1affc

Please sign in to comment.