Skip to content

Commit

Permalink
Updated docs and added comment to template file
Browse files Browse the repository at this point in the history
  • Loading branch information
mohsenari committed Feb 5, 2024
1 parent 4393abe commit d68a32b
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 2 deletions.
13 changes: 13 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM jetpackio/devbox:latest

# Installing your devbox project
WORKDIR /code
USER ${DEVBOX_USER}:${DEVBOX_USER}
COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.json devbox.json
COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.lock devbox.lock
# Copy the rest of your project files and directories


RUN devbox run -- echo "Installed Packages."

CMD ["devbox", "shell"]
2 changes: 1 addition & 1 deletion docs/app/docs/cli_reference/devbox_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Top level command for generating Devcontainers, Dockerfiles, and other useful files for your Devbox Project.

```bash
devbox generate <devcontainer|dockerfile|direnv> [flags]
devbox generate <devcontainer|dockerfile|direnv|readme> [flags]
```

## Options
Expand Down
2 changes: 2 additions & 0 deletions docs/app/docs/cli_reference/devbox_generate_devcontainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Generate Dockerfile and devcontainer.json files necessary to run VSCode in remot
devbox generate devcontainer [flags]
```

The generated Dockerfile only copies `devbox.json` and `devbox.lock` files into the container. Users need to modify this file to include copying their project files as well.

### Options

<!-- Markdown Table of Options -->
Expand Down
2 changes: 2 additions & 0 deletions docs/app/docs/cli_reference/devbox_generate_dockerfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Generate a Dockerfile that replicates devbox shell. Can be used to run devbox sh
devbox generate dockerfile [flags]
```

The generated Dockerfile only copies `devbox.json` and `devbox.lock` files into the container. Users need to modify this file to include copying their project files as well.

## Options

<!-- Markdown Table of Options -->
Expand Down
2 changes: 1 addition & 1 deletion internal/devbox/generate/tmpl/devcontainerDockerfile.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.lock devbox.lock
COPY devbox.json devbox.json
COPY devbox.lock devbox.lock
{{- end}}

# Copy the rest of your project files and directories here:
{{if len .LocalFlakeDirs}}
# Step 6: Copying local flakes directories
{{- end}}
Expand Down

0 comments on commit d68a32b

Please sign in to comment.