Update dependecies #5595

Nils-ChristianIseke · 2025-05-09T15:12:44Z

Use noble for CI.

Nils-ChristianIseke · 2025-05-10T12:50:02Z

docker/image/Dockerfile

+RUN . /opt/ros2doc/bin/activate && pip3 install -r requirements.txt -c constraints.txt
+
+RUN echo "source /opt/ros2doc/bin/activate" >> /home/$user/.bashrc
+USER $user


Is there any reason that we use a non root user in the container? In the current setup we would need sudo rights for installing pip and apt requirements.

I'm not exactly sure. I looked at the original PR that added it (#1038), and it wasn't discussed. It may be coming from an old Jenkins config, and, given that it's named rosindex, I'm guessing it's meant to preserve permissions/owner of the artifact (HTML) files in the mounted volume/directory. I would keep it as-is and use --user.

Nils-ChristianIseke · 2025-05-10T12:53:24Z

constraints.txt

-MarkupSafe==2.0.1
-packaging==21.3
-pbr==5.8.0
+alabaster==0.7.16


Fixed dependencies to latest available versions because they are working with all tools. Or is there a specific reason to stick to the dep availible via apt?

Nils-ChristianIseke · 2025-05-10T12:58:49Z

@christophebedard some open questions from my side. Happy if you could have a look?

christophebedard · 2025-05-10T13:07:27Z

I will take a look once I'm back from vacation on Tuesday-ish!

Nils-ChristianIseke · 2025-05-12T08:04:48Z

docker/image/Dockerfile

-FROM ubuntu:jammy
+FROM ubuntu:noble


Any plans using a deployed Docker image instead of the Dockerfile? I can create an issue for this if you think this is reasonable to do.

What do you mean?

Do you mean installing the dependencies into the image itself instead of installing them through CMD when the container actually gets used to build the docs? The way it currently works, the container will install the exact versions of dependencies as specified by the docs/repo being built basically at the same time as the docs are built. I think we should keep it as-is for now, but you can open a follow-up issue.

Nils-ChristianIseke · 2025-05-12T08:21:24Z

docker/image/Dockerfile

@@ -20,7 +20,8 @@ RUN apt-get update && \
        graphviz \
        locales \
        make \
-        python3-pip && \
+        python3-pip \


Just to support uv , we could consider uv instead of pip (much faster, venv support, better dep. management). Can create an issue for this if wanted.

I'd prefer keeping pip. I don't think there's a big enough reason to move to another tool.

christophebedard

Sorry for the delay. I have some comments and suggestions.

christophebedard · 2025-06-16T23:43:41Z

docker/image/Dockerfile

@@ -20,7 +20,8 @@ RUN apt-get update && \
        graphviz \
        locales \
        make \
-        python3-pip && \
+        python3-pip \


I'd prefer keeping pip. I don't think there's a big enough reason to move to another tool.

christophebedard · 2025-06-16T23:44:35Z

docker/image/Dockerfile

-FROM ubuntu:jammy
+FROM ubuntu:noble


What do you mean?

Do you mean installing the dependencies into the image itself instead of installing them through CMD when the container actually gets used to build the docs? The way it currently works, the container will install the exact versions of dependencies as specified by the docs/repo being built basically at the same time as the docs are built. I think we should keep it as-is for now, but you can open a follow-up issue.

christophebedard · 2025-06-16T23:44:44Z

README.md

@@ -37,7 +37,7 @@ pip install -r requirements.txt -c constraints.txt

 ### Pinned versions

-For development we currently use Jammy (Ubuntu 22.04) as our build platform.
+For development we currently use Noble (Ubuntu 22.04) as our build platform.


Suggested change

For development we currently use Noble (Ubuntu 22.04) as our build platform.

For development we currently use Noble (Ubuntu 24.04) as our build platform.

christophebedard · 2025-06-16T23:47:09Z

.github/workflows/test.yml

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
-          python-version: '3.10'
+          python-version: '3.12.2'


Can we simply specify '3.12' here and everywhere else? Ubuntu 22.04 had 3.10.6 and we used '3.10'. Ubuntu 24.04 has 3.12.3, so let's use '3.12'.

christophebedard · 2025-06-16T23:50:24Z

conf.py

+# Google Analytics configuration
+googleanalytics_id = 'G-EVD5Z6G6NH'
+googleanalytics_enabled = True
 # -- Options for HTML output ----------------------------------------------

 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
 html_theme_options = {
-    'analytics_id': 'G-EVD5Z6G6NH',


I was wondering why this needed to be moved to googleanalytics_id and found the answer here: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-analytics_id

analytics_id
...
Deprecated since version 3.0.0: The analytics_id option is deprecated, use the sphinxcontrib-googleanalytics extension instead.

christophebedard · 2025-06-16T23:54:43Z

requirements.txt

 sphinxcontrib-mermaid
 sphinx-tamer
+sphinxcontrib-googleanalytics


Small ordering fix:

Suggested change

sphinxcontrib-mermaid

sphinx-tamer

sphinxcontrib-googleanalytics

sphinx-tamer

sphinxcontrib-googleanalytics

sphinxcontrib-mermaid

christophebedard · 2025-06-17T00:19:14Z

docker/image/Dockerfile

+RUN . /opt/ros2doc/bin/activate && pip3 install -r requirements.txt -c constraints.txt
+
+RUN echo "source /opt/ros2doc/bin/activate" >> /home/$user/.bashrc
+USER $user


I'm not exactly sure. I looked at the original PR that added it (#1038), and it wasn't discussed. It may be coming from an old Jenkins config, and, given that it's named rosindex, I'm guessing it's meant to preserve permissions/owner of the artifact (HTML) files in the mounted volume/directory. I would keep it as-is and use --user.

christophebedard · 2025-06-17T00:35:20Z

.devcontainer/devcontainer.json

@@ -1,11 +1,11 @@
 {
 	"name": "ROS 2 Documentation",
 	"build": {
-		"dockerfile": "../docker/image/Dockerfile"
+		"dockerfile": "../docker/image/Dockerfile",
+		"context": ".."


The context isn't needed (but the postCreateCommand is) if we keep CMD.

Nils-ChristianIseke marked this pull request as draft May 9, 2025 15:12

Nils-ChristianIseke mentioned this pull request May 9, 2025

Bumb CI to 24.04 #5244

Open

4 tasks

Nils-ChristianIseke added 5 commits May 10, 2025 14:28

Fix dep (requirement.txt) to versions present in apt

c553398

Update Dockerfile Devcontainer.json

a8e759b

Update workflows

6c648fe

Update conf.py

830244a

Fix constraints to latest version available via pip

098a31a

Nils-ChristianIseke force-pushed the UpdateDependecies branch from 70818c3 to 098a31a Compare May 10, 2025 12:34

Update python version in workflows.

b3f38c6

Nils-ChristianIseke commented May 10, 2025

View reviewed changes

Adapt Readme to noble

b9fe431

Nils-ChristianIseke marked this pull request as ready for review May 10, 2025 12:58

christophebedard self-requested a review May 10, 2025 13:06

Nils-ChristianIseke commented May 12, 2025

View reviewed changes

christophebedard self-assigned this May 22, 2025

christophebedard reviewed Jun 17, 2025

View reviewed changes

	For development we currently use Noble (Ubuntu 22.04) as our build platform.
	For development we currently use Noble (Ubuntu 24.04) as our build platform.

		FROM ubuntu:jammy
		FROM ubuntu:noble

		FROM ubuntu:jammy
		FROM ubuntu:noble

Update dependecies #5595

Are you sure you want to change the base?

Update dependecies #5595

Uh oh!

Conversation

Nils-ChristianIseke commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nils-ChristianIseke commented May 10, 2025

Uh oh!

christophebedard commented May 10, 2025

Uh oh!

Nils-ChristianIseke May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christophebedard left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Nils-ChristianIseke commented May 9, 2025 •

edited

Loading

Nils-ChristianIseke May 12, 2025 •

edited

Loading