Add note about required-ros-distributions caveat on Ubuntu

[christophebedard]

As suggested here: #439 (comment)

Signed-off-by: Christophe Bedard bedard.christophe@gmail.com

[christophebedard]

@amacneil let me know if this looks OK to you!

[codecov]

Codecov Report

Merging #464 (3234b26) into master (824b6c5) will decrease coverage by 0.12%.
The diff coverage is n/a.

❗ Current head 3234b26 differs from pull request most recent head af66adc. Consider uploading reports for the commit af66adc to get more accurate results

@@            Coverage Diff             @@
##           master     #464      +/-   ##
==========================================
- Coverage   93.25%   93.12%   -0.13%     
==========================================
  Files           8        8              
  Lines         163      160       -3     
  Branches       14       14              
==========================================
- Hits          152      149       -3     
  Misses         11       11              

Impacted Files	Coverage Δ
src/setup-ros-windows.ts	77.41% <0.00%> (-0.71%)	⬇️
src/package_manager/pip.ts	100.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 824b6c5...af66adc. Read the comment docs.

[emersonknapp]

I feel like this note could be a little more concise. Note that https://github.com/ros-tooling/setup-ros/blob/master/action.yml#L19 documents this feature (action.yml is essentially the "API docs" for an action). Maybe this should just be a bold note that "required-ros-distributions installs the desktop variant for that distribution. This option is not required, and should probably be avoided in most workflows. It is retained for historical reasons and those who specifically do not care about whether their application specifies its dependencies properly."

[christophebedard]

Sure, I changed it to that: 3b239dc

I also updated the action.yml file to mention that required-ros-distributions installs binaries on Windows: 3234b26