Added rustdoc check step to CI

[mohitsaxenaknoldus]

Closes #113

[nnmm]

I think this won't work yet – you need to execute this in each package's directory, not the top-level directory.

[mohitsaxenaknoldus]

I think this won't work yet – you need to execute this in each package's directory, not the top-level directory.

Oh! My bad...check now?

[nnmm]

Could you do it the same way as the clippy step? That should work.

[mohitsaxenaknoldus]

Could you do it the same way as the clippy step? That should work.

Done.

[nnmm]

You removed the filter for ament_cargo packages, so now it tries to run rustdoc on Python and CMake packages too.

[mohitsaxenaknoldus]

You removed the filter for ament_cargo packages, so now it tries to run rustdoc on Python and CMake packages too.

Oh! I thought we wanted this for every package, my bad! Fixed.

[nnmm]

Now we're getting somewhere – though now it can't find the dependencies, because the .cargo folder is somewhere else.

If you add back the cd ${{ steps.build.outputs.ros-workspace-directory-name }} from the clippy step, it should probably work. That's where the colcon build command ran, so it contains the .cargo folder.

[mohitsaxenaknoldus]

Now we're getting somewhere – though now it can't find the dependencies, because the .cargo folder is somewhere else.

If you add back the cd ${{ steps.build.outputs.ros-workspace-directory-name }} from the clippy step, it should probably work. That's where the colcon build command ran, so it contains the .cargo folder.

Added

[nnmm]

Looks like we also need the last command from clippy, sourcing the ROS 2 installation. I wasn't sure about that.

[mohitsaxenaknoldus]

Looks like we also need the last command from clippy, sourcing the ROS 2 installation. I wasn't sure about that.

This one?
. /opt/ros/${{ matrix.ros_distro }}/setup.sh

[nnmm]

Yep

[mohitsaxenaknoldus]

Yep

Added

[nnmm]

Looks like rclrs_examples is failing the rustdoc step, because it contains multiple binaries.

I'd suggest to just filter out rclrs_examples for now.

[mohitsaxenaknoldus]

Looks like rclrs_examples is failing the rustdoc step, because it contains multiple binaries.

I'd suggest to just filter out rclrs_examples for now.

Done.

[nnmm]

I can't see where you filtered it out?

[mohitsaxenaknoldus]

I can't see where you filtered it out?

for path in $(colcon list | awk '$3 == "(ament_cargo)" { print $2 }' | sed -n 'p;n'); do

[nnmm]

Ah, thanks. That works, but it's not obvious what it's intended to do. Could you do this instead?
awk '$3 == "(ament_cargo)" && $1 != "rclrs_examples" { print $2 }'

[mohitsaxenaknoldus]

Ah, thanks. That works, but it's not obvious what it's intended to do. Could you do this instead? awk '$3 == "(ament_cargo)" && $1 != "rclrs_examples" { print $2 }'

Done

[nnmm]

Thanks!