Skip to content

Conversation

@jgarber623
Copy link
Member

Description

This PR adds Dev Container configuration to the project for use in Visual Studio Code and/or GitHub Codespaces (or, really, anything else that supports Dev Containers but this is really a Microsoft thing). The goal is to ease onboarding for anyone looking to contribute. The shortest path is to use VS Code and its Dev Containers extension to manage all of that.

Links

Commits

  • Add IRB config, update console script
  • Add Dev Container configuration

The `.irbrc` file configures IRB in a couple of ways, most notably by
dropping a local `.irb_history` file (ignored by Git) that'll persist
across `bin/console` sessions. Useful!
This is a pretty simple implementation, derived from the rails/rails
repo. The `devcontainer.json` is straightforward and doesn't do anything
too atypical for a basic Ruby dev container.

Rather than configure everything in the JSON file, we kick out to
`docker-compose.yml` and `Dockerfile`. This should give some flexibility
to folks that don't use VS Code or Codespaces but still want to run
things manually via Docker:

```sh
docker compose --file .devcontainer/docker-compose.yml up --detach

docker compose --file .devcontainer/docker-compose.yml exec default \
  /bin/bash

docker compose --file .devcontainer/docker-compose.yml up
```
@jgarber623 jgarber623 self-assigned this Nov 22, 2023
@jgarber623 jgarber623 merged commit 5753c21 into main Nov 22, 2023
@jgarber623 jgarber623 deleted the add-devcontainer branch November 22, 2023 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants