Skip to content

Commit 8cab41f

Browse files
committed
Add an example override and update docs for dev containers
1 parent 97ed5a8 commit 8cab41f

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,48 @@ Start the application and its dependencies via docker:
3333
docker-compose up
3434
```
3535

36+
### Using the dev-container
37+
38+
There is a dedicated image called `dev-container`, and the easiest way to use this is to use the override:
39+
40+
`cp docker-compose.override.yml.example docker-compose.override.yml`
41+
42+
Now when you run `docker compose up -d` it will always use the `dev-container` image.
43+
44+
When adding a vscode project the dev-container should be automatically found and a dialog will show asking if
45+
you want to use this, but failing that you can open the cmd palette with `cmd + shift + p` and call:
46+
47+
`Dev Containers: Reopen in Container`
48+
49+
If there's an issue, do check the logs, but you can run:
50+
51+
`Dev Containers: Rebuild and Reopen in Container`
52+
53+
and there's also a 'without cache' variant, to ensure packages are re-built.
54+
3655
#### Updating gems inside the container
3756

38-
This can be done with the `bin/with-builder.sh` script:
57+
If running inside a dev-container:
58+
59+
```
60+
bundle install
61+
```
62+
63+
or outside with:
64+
65+
```
66+
docker compose run --rm --no-deps api bundle install
67+
```
68+
69+
This can also be done with the `bin/with-builder.sh` script:
3970

4071
```
4172
./bin/with-builder.sh bundle update
4273
```
4374

44-
which should update the Gems in the container, without the need for rebuilding.
75+
which should update the Gems in the container.
76+
77+
None of these methods require rebuilding.
4578

4679
### Seeding
4780

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.devcontainer/docker-compose.yml

0 commit comments

Comments
 (0)