Skip to content

[ROS] Update Official Docker image docs #2578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

ruffsl
Copy link
Contributor

@ruffsl ruffsl commented May 29, 2025

Refreshes the ROS documentation using updated links, cleans out old content, and improves the demo examples.

Related:

ruffsl added 28 commits May 28, 2025 13:42
as final ROS 1 version, Noetic, is now EOL
as docs page is more up-to-date and pertinent for users
to avoid docs from becoming stale
as example to save on image size
as well as on build time using caching
for readability of each stage
and update rosdep along with apt list
to ensure package index is fresh
to include additional relevant entries
to focus on primary targets
accounting for included docker-clean default
to avoid running rosdep update for each source change
as docker build --no-cache can still be used to force update
@ruffsl
Copy link
Contributor Author

ruffsl commented May 30, 2025

@mikaelarguedas or @tfoote , could you take a look this? Think it's about ready to go. Thanks!

Copy link
Contributor

@tfoote tfoote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It generally looks like a good improvement. The naming of installer versus runner seem a little bit confusing to me. I feel like installer might be clearer with a name more like "upstream" or "prebuilt" maybe.

@mikaelarguedas
Copy link
Contributor

looks great overall !

agreed with Tully's comment

maybe using latest instead of rolling for the base images would be as future-proof and give example of using stable distros

while keeping with uniquely spelled noun
that is self descriptive yet unmistakable
@ruffsl
Copy link
Contributor Author

ruffsl commented Jun 2, 2025

maybe using latest instead of rolling for the base images would be as future-proof and give example of using stable distros

For reproducibility, I'd generally like to discourage implicit or explicit use of latest in favor of a distro specific tag. If any novice user copies an example using latest, chances are it'll break their Dockerfile a much later, catching them off guard once a new stable distro is release, where as if they copied from the example using rolling, it's more apparent that it a rolling distribution and if they want swap the tag for something else. However, if that kind of breakage is their intent, e.g. for CI tracking latest LTS, then then can conscientiously make that choice, setting the tag to latest instead.

Also, this exemplifies how to postfix an ARG to minimize the runtime image, and ros:latest-ros-core is non-existent.

FROM $FROM_IMAGE-ros-core AS runner

@ruffsl ruffsl marked this pull request as ready for review June 2, 2025 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants