Skip to content

Commit

Permalink
Default to empty vcs-repo-file-url (#566)
Browse files Browse the repository at this point in the history
Fixes #561

This changes the default value for the `vcs-repo-file-url` input to an empty
string. Therefore, by default, action-ros-ci will rely on binaries
(e.g. installed by setup-ros) for any dependencies.

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
  • Loading branch information
christophebedard authored Mar 9, 2021
1 parent a622fb7 commit e2bb22a
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ jobs:
matrix:
os: [macOS-latest, windows-latest, ubuntu-20.04]
ros_distribution: [foxy, rolling]
env:
DISTRO_REPOS_URL: "https://raw.githubusercontent.com/ros2/ros2/${{ matrix.ros_distribution == 'rolling' && 'master' || matrix.ros_distribution }}/ros2.repos"
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2.1.4
Expand All @@ -189,6 +191,7 @@ jobs:
with:
package-name: ament_copyright
target-ros2-distro: ${{ matrix.ros_distribution }}
vcs-repo-file-url: ${{ env.DISTRO_REPOS_URL }}
- run: test -d "${{ steps.test_single_package.outputs.ros-workspace-directory-name }}/install/ament_copyright"
name: "Check that ament_copyright install directory is present"

Expand All @@ -198,6 +201,7 @@ jobs:
with:
package-name: ament_copyright ament_lint
target-ros2-distro: ${{ matrix.ros_distribution }}
vcs-repo-file-url: ${{ env.DISTRO_REPOS_URL }}
- run: test -d "${{ steps.test_multiple_packages.outputs.ros-workspace-directory-name }}/install/ament_copyright"
name: "Check that ament_copyright install directory is present"
- run: test -d "${{ steps.test_multiple_packages.outputs.ros-workspace-directory-name }}/install/ament_lint"
Expand All @@ -210,6 +214,7 @@ jobs:
with:
package-name: rmw_implementation
target-ros2-distro: ${{ matrix.ros_distribution }}
vcs-repo-file-url: ${{ env.DISTRO_REPOS_URL }}
- run: test -d "${{ steps.test_connext_dependency.outputs.ros-workspace-directory-name }}/install/rmw_implementation"
name: "Check that rmw_implementation install directory is present"
if: matrix.os == 'ubuntu-20.04'
Expand All @@ -222,6 +227,7 @@ jobs:
colcon-mixin-repository: https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml
package-name: ament_copyright
target-ros2-distro: ${{ matrix.ros_distribution }}
vcs-repo-file-url: ${{ env.DISTRO_REPOS_URL }}
- run: test -d "${{ steps.test_mixin.outputs.ros-workspace-directory-name }}/install/ament_copyright"
name: "Check that ament_copyright install directory is present"

Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The action first assembles a workspace, then runs `colcon build`, and `colcon te

The workspace is built by running:

- `vcs import` on the repo file specified through the `vcs-repo-file-url` argument (defaults to `https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos`).
- `vcs import` on the repo file(s) specified through the `vcs-repo-file-url` argument, if any (defaults to none)
- checkout the code under test in the workspace using `vcs`
- `rosdep install` for the workspace, to get its dependencies
- run `colcon build` for all packages specified in `package-name`
Expand Down Expand Up @@ -64,6 +64,7 @@ steps:
with:
package-name: ament_copyright
target-ros2-distro: foxy
vcs-repo-file-url: https://raw.githubusercontent.com/ros2/ros2/foxy/ros2.repos
```
### Build with a custom `repos` or `rosinstall` file
Expand Down Expand Up @@ -101,7 +102,6 @@ steps:
with:
package-name: my_package
target-ros1-distro: melodic
vcs-repo-file-url: ""
```

### Enable Address Sanitizer to automatically report memory issues
Expand All @@ -112,6 +112,8 @@ memory corruption bugs.
```yaml
steps:
- uses: ros-tooling/setup-ros@v0.1
with:
required-ros-distributions: foxy
- uses: ros-tooling/action-ros-ci@v0.1
with:
colcon-mixin-name: asan
Expand Down Expand Up @@ -142,6 +144,8 @@ preferable to use a `colcon` mixin to pass the appropriate flags automatically.
```yaml
steps:
- uses: ros-tooling/setup-ros@v0.1
with:
required-ros-distributions: foxy
- uses: ros-tooling/action-ros-ci@v0.1
with:
package-name: my_package
Expand All @@ -164,6 +168,8 @@ preferable to use a `colcon` mixin to pass the appropriate flags automatically.
```yaml
steps:
- uses: ros-tooling/setup-ros@v0.1
with:
required-ros-distributions: foxy
- uses: ros-tooling/action-ros-ci@v0.1
with:
package-name: my_package
Expand All @@ -184,6 +190,8 @@ See [action/codecov-action](https://github.com/codecov/codecov-action) documenta
```yaml
steps:
- uses: ros-tooling/setup-ros@v0.1
with:
required-ros-distributions: foxy
- uses: ros-tooling/action-ros-ci@v0.1
with:
package-name: my_package
Expand Down
8 changes: 5 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,11 @@ inputs:
required: false
vcs-repo-file-url:
description: |
repo file URL passed to vcs to initialize the colcon workspace.
The URL may point to a local file, such as file://path/to/file.txt
default: "https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos"
Repo file URL passed to vcs to initialize the colcon workspace.
The URL may point to a local file, such as file://path/to/file.txt.
For example, for ROS 2 Rolling source repositories, use:
https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos
default: ""
outputs:
ros-workspace-directory-name:
description: |
Expand Down

0 comments on commit e2bb22a

Please sign in to comment.