[openstreetmap/openstreetmap-website] Add devcontainer configuration (Issue #5264)

Andy Allan notifications at github.com
Wed Oct 16 14:45:57 UTC 2024


We added support for Docker-based development in [2021](https://github.com/openstreetmap/openstreetmap-website/pull/2409) (based on a PR started in 2019). At this time there were no clear conventions for setting up docker-based development environments, so we did our own thing.

Nowadays, a number of tools support the "[Development Container](https://containers.dev)" specification. This provides a few additional benefits, for example tighter integration between code editors and the containers (e.g. running the rubocop process within the container, but seeing the syntax highlighting in your editor UI). Dev containers are [supported](https://containers.dev/supporting) by vscode and intellij code editors, and are also a part of Github Codespaces. Codespaces allow developers to make code changes, run tests and make PRs, all without installing anything locally. So it would be nice to fully support that too.

It's also notable that rails 7.2 added built-in support for devcontainers configuration, so running `bundle exec rails devcontainer` gets us started on the setup and generating the configuration files.

I therefore propose:
* We set up the devcontainer configuration and make sure it works.
* We move the docker part of CI to use the devcontainer configuration.
* We remove the original Docker configuration and update the documentation.
* We also consider removing the vagrant configuration. 

-- 
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/issues/5264
You are receiving this because you are subscribed to this thread.

Message ID: <openstreetmap/openstreetmap-website/issues/5264 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20241016/4a4e9f7d/attachment.htm>


More information about the rails-dev mailing list