Skip to content

Add Docker container for development#307

Merged
robwoolley merged 3 commits intoros-infrastructure:masterfrom
robwoolley:docker-pr
Jan 22, 2025
Merged

Add Docker container for development#307
robwoolley merged 3 commits intoros-infrastructure:masterfrom
robwoolley:docker-pr

Conversation

@robwoolley
Copy link
Contributor

This Docker container is based on the osrf/ros2:devel container image. It adds the additional dependencies required to develop superflore.

It may be used independently, but it is intended for use as a VSCode devcontainer for development of superflore.

The CI system picked up non-conformance issues with recent changes
to the ebuild generator.

Fix lines that exceed 79 characters and remove an used chunk_count
variable.

Signed-off-by: Rob Woolley <rob.woolley@windriver.com>
@robwoolley
Copy link
Contributor Author

The CI tests fail with the following message:

b"/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/gen_packages.py:159:80: E501 line too long (88 > 79 characters)\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/gen_packages.py:177:80: E501 line too long (99 > 79 characters)\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/gen_packages.py:212:80: E501 line too long (88 > 79 characters)\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/overlay_instance.py:85:13: F841 local variable 'chunk_count' is assigned to but never used\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/overlay_instance.py:99:80: E501 line too long (80 > 79 characters)\n5\n"
b'/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/gen_packages.py:159:80: E501 line too long (88 > 79 characters)\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/gen_packages.py:177:80: E501 line too long (99 > 79 characters)\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/gen_packages.py:212:80: E501 line too long (88 > 79 characters)\n/home/runner/work/superflore/superflore/tests/../superflore/generators/ebuild/overlay_instance.py:99:80: E501 line too long (80 > 79 characters)\n4\n'

These are not files being changed in this commit. They are specific to the ebuild generator which is unrelated to the Docker container.

This is solved by #308 .

Signed-off-by: Rob Woolley <rob.woolley@windriver.com>
Signed-off-by: Rob Woolley <rob.woolley@windriver.com>
@@ -0,0 +1,38 @@
# superflore-devel
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't remember exactly how python packaging handles extraneous files. Do we need to explicitly "ignore" these so that they aren't incorporated into the packaged archive or does this count as a data file which pip won't include unless told.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I'll look into this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This doesn't seem to be a problem for Setuptools, Poetry, Flit, Hatch, or PDM. Most have explicit include and excludes lists, but setuptools also has a few pre-defined files that get automatically included: https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html

It doesn't seem like the Dockerfile or setup script would get automatically included.

@robwoolley robwoolley merged commit a0636a3 into ros-infrastructure:master Jan 22, 2025
12 checks passed
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.

2 participants