[WIP] Add dev container support

[Huoleit]

Summary

Caution

This is a work-in-progress PR. It is still under heavy development. Check the TODO section for tasks done and pending.

In this PR, dev container support is added. The whole dev container is split into two parts.

• .github/.devcontainer: holds everything needed for the SMB simulation environment. It should be built and uploaded to the GitHub registry by CI. For users who wish to run commands with docker CLI, it is also the image pulled from the register.
• .devcontainer: It is a top-level dev config that is dedicated to vscode devcontainer extension. It extends the base image and allows users to customize their development environment. For example, add vscode extensions, preserve bash history, etc.

More details here

TODO

• Add base .devcontainer.json and Dockerfile
• Add cache-preserving multi-stage build to the base image
• Add VNC support - Windows and Mac users can fallback to VNC if X11 forwarding does not work
• Add postCreateCommand.bash to compile catkin_ws
• Add development tools and vscode extensions
• Add alias
• Finalize top-level .devcontainer.json and Dockerfile
• Add dev container CI
• Shrink image size (the whole image is 13GB, Pytorch takes 8GB)

[mantelt]

First of all: thanks for looking into this!
I'm new to dev containers, so please be patient ;-)

As pointed out before, I would like to achieve two goals:

• have some basic CI to make sure everything builds. currently, this is achieved by building smb_dev and SuperMegaBot using Github Actions.

• distribute a dev environment to the participants that is easy to set up. (I referred to this as deployment, but only now figured out that this might be bad usage of the term)

From what I gathered so far, a dev container is the right way to achieve both goals in one go. But we might need to adjust a few github actions to make everything consistent and keep it efficient.

To me, it feels like it will be more efficient if we quickly discuss your idea on what to implement once more directly. What do you think?

[Huoleit]

@deepanaishtaweera and I had a meeting about the whole setup a week before. More details are shown in the notes here.
https://onyx-time-1bc.notion.site/Apr-10-2f4f4c13aa624b14a4616886e15601db?pvs=4

[Huoleit]

First of all: thanks for looking into this! I'm new to dev containers, so please be patient ;-)

As pointed out before, I would like to achieve two goals:

• have some basic CI to make sure everything builds. currently, this is achieved by building smb_dev and SuperMegaBot using Github Actions.
• distribute a dev environment to the participants that is easy to set up. (I referred to this as deployment, but only now figured out that this might be bad usage of the term)

From what I gathered so far, a dev container is the right way to achieve both goals in one go. But we might need to adjust a few github actions to make everything consistent and keep it efficient.

To me, it feels like it will be more efficient if we quickly discuss your idea on what to implement once more directly. What do you think?

Sure, we can discuss it and I can give a demo. I'll message you on Slack to schedule a time.