feat(template): Add VSCode devcontainers by CuriousLearner · Pull Request #43 · CuriousLearner/django-keel

CuriousLearner · 2026-03-08T01:27:06Z

Summary

Add VS Code devcontainer support to generated projects. The devcontainer reuses the existing Docker Compose setup and provides a one-click containerized development environment.

Related Issues

Fixes #42

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Template configuration change
CI/CD update
Dependency update
Refactoring (no functional changes)

What Changed

Two new Jinja template files added under template/.devcontainer/:

devcontainer.json.jinja - Main devcontainer config that references the existing
docker-compose.yml via a compose override pattern. Includes conditional port
forwarding (Redis, Vite, Temporal, Jaeger), minimal VS Code extensions (Python,
Pylance, Ruff, Django, Docker, GitLens), correct Python interpreter path for
uv/Poetry, and a post-create command to install deps and run migrations.
docker-compose.devcontainer.yml.jinja - Override compose file that replaces the
web service command with sleep infinity, allowing VS Code to manage the
container lifecycle instead of gunicorn.

Additional Notes

Reviewer Notes:

Copilot

Pull request overview

Adds VS Code Dev Container support to projects generated from this template, reusing the existing Docker Compose-based dev stack to provide a containerized, “open in container” workflow.

Changes:

Introduces a devcontainer.json template that attaches VS Code to the existing web Compose service and forwards common service ports conditionally.
Adds a Compose override template intended to keep the web container running under VS Code control (via sleep infinity).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
`template/.devcontainer/devcontainer.json.jinja`	Devcontainer definition (Compose-based), port forwarding, editor extensions/settings, and post-create setup command.
`template/.devcontainer/docker-compose.devcontainer.yml.jinja`	Compose override for devcontainer usage (overrides the `web` service command/environment).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-08T01:31:48Z

+  "forwardPorts": [
+    8000,
+    5432,
+    8025{% if cache == 'redis' %},
+    6379{% endif %}{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %},
+    5173{% endif %}{% if background_tasks in ['temporal', 'both'] %},
+    7233,
+    8080{% endif %}{% if observability_level == 'full' %},
+    16686{% endif %}


The Jinja conditionals in the forwardPorts array will render invalid JSON in cases where the feature flags are disabled. Commas placed immediately after {% if ... %} (e.g., on the frontend, background_tasks, observability_level blocks) are literal output and will remain even when the condition is false, leaving dangling commas in the array. Move commas inside the conditional blocks (or construct the list in Jinja and serialize it) so the rendered file is always valid JSON.

Suggested change

"forwardPorts": [

8000,

5432,

8025{% if cache == 'redis' %},

6379{% endif %}{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %},

5173{% endif %}{% if background_tasks in ['temporal', 'both'] %},

7233,

8080{% endif %}{% if observability_level == 'full' %},

16686{% endif %}

{% set forward_ports = [8000, 5432, 8025] %}

{% if cache == 'redis' %}

{% set _ = forward_ports.append(6379) %}

{% endif %}

{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %}

{% set _ = forward_ports.append(5173) %}

{% endif %}

{% if background_tasks in ['temporal', 'both'] %}

{% set _ = forward_ports.append(7233) %}

{% set _ = forward_ports.append(8080) %}

{% endif %}

{% if observability_level == 'full' %}

{% set _ = forward_ports.append(16686) %}

{% endif %}

"forwardPorts": [

{% for port in forward_ports %}

{{ port }}{% if not loop.last %},{% endif %}

{% endfor %}

Copilot · 2026-03-08T01:31:48Z

+    8025{% if cache == 'redis' %},
+    6379{% endif %}{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %},
+    5173{% endif %}{% if background_tasks in ['temporal', 'both'] %},
+    7233,
+    8080{% endif %}{% if observability_level == 'full' %},
+    16686{% endif %}
+  ],
+  "portsAttributes": {
+    "8000": { "label": "Django", "onAutoForward": "notify" },
+    "5432": { "label": "PostgreSQL", "onAutoForward": "silent" },
+    "8025": { "label": "Mailpit UI", "onAutoForward": "silent" }{% if cache == 'redis' %},
+    "6379": { "label": "Redis", "onAutoForward": "silent" }{% endif %}{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %},
+    "5173": { "label": "Vite", "onAutoForward": "notify" }{% endif %}{% if background_tasks in ['temporal', 'both'] %},
+    "7233": { "label": "Temporal", "onAutoForward": "silent" },
+    "8080": { "label": "Temporal UI", "onAutoForward": "silent" }{% endif %}{% if observability_level == 'full' %},
+    "16686": { "label": "Jaeger UI", "onAutoForward": "silent" }{% endif %}


portsAttributes has the same JSON rendering problem as forwardPorts: commas placed outside the {% if ... %} blocks (right after the opening {% if %} tag) will be emitted even when the condition is false, producing invalid JSON (e.g., a trailing comma after the Mailpit entry when Redis is disabled). Adjust the template so commas are only emitted when the corresponding attribute entry is emitted.

Suggested change

8025{% if cache == 'redis' %},

6379{% endif %}{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %},

5173{% endif %}{% if background_tasks in ['temporal', 'both'] %},

7233,

8080{% endif %}{% if observability_level == 'full' %},

16686{% endif %}

],

"portsAttributes": {

"8000": { "label": "Django", "onAutoForward": "notify" },

"5432": { "label": "PostgreSQL", "onAutoForward": "silent" },

"8025": { "label": "Mailpit UI", "onAutoForward": "silent" }{% if cache == 'redis' %},

"6379": { "label": "Redis", "onAutoForward": "silent" }{% endif %}{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %},

"5173": { "label": "Vite", "onAutoForward": "notify" }{% endif %}{% if background_tasks in ['temporal', 'both'] %},

"7233": { "label": "Temporal", "onAutoForward": "silent" },

"8080": { "label": "Temporal UI", "onAutoForward": "silent" }{% endif %}{% if observability_level == 'full' %},

"16686": { "label": "Jaeger UI", "onAutoForward": "silent" }{% endif %}

8025

{% if cache == 'redis' %}

, 6379

{% endif %}

{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %}

, 5173

{% endif %}

{% if background_tasks in ['temporal', 'both'] %}

, 7233,

8080

{% endif %}

{% if observability_level == 'full' %}

, 16686

{% endif %}

],

"portsAttributes": {

"8000": { "label": "Django", "onAutoForward": "notify" },

"5432": { "label": "PostgreSQL", "onAutoForward": "silent" },

"8025": { "label": "Mailpit UI", "onAutoForward": "silent" }

{% if cache == 'redis' %}

, "6379": { "label": "Redis", "onAutoForward": "silent" }

{% endif %}

{% if frontend == 'htmx-tailwind' and frontend_bundling == 'vite' %}

, "5173": { "label": "Vite", "onAutoForward": "notify" }

{% endif %}

{% if background_tasks in ['temporal', 'both'] %}

, "7233": { "label": "Temporal", "onAutoForward": "silent" },

"8080": { "label": "Temporal UI", "onAutoForward": "silent" }

{% endif %}

{% if observability_level == 'full' %}

, "16686": { "label": "Jaeger UI", "onAutoForward": "silent" }

{% endif %}

Copilot · 2026-03-08T01:31:48Z

+      }
+    }
+  },
+  "postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry install && python manage.py migrate{% endif %}"


For Poetry projects, postCreateCommand runs poetry install but the devcontainer sets python.defaultInterpreterPath to /usr/local/bin/python and then runs python manage.py migrate. By default Poetry creates a virtualenv for non-root users, so dev dependencies may be installed into a venv that VS Code (and the python invocation) won’t use. Consider forcing virtualenvs.create=false in the devcontainer (e.g., via env var or a poetry config ... --local step) or switching the migration command and interpreter selection to use the Poetry environment consistently.

Suggested change

"postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry install && python manage.py migrate{% endif %}"

"postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry config virtualenvs.create false --local && poetry install && python manage.py migrate{% endif %}"

Copilot · 2026-03-08T01:31:48Z

+  web:
+    command: sleep infinity
+    environment:
+      - DEBUG=True


In Docker Compose override semantics, the environment: sequence here will replace the environment: sequence from ../docker-compose.yml rather than merge with it. That drops important container-specific env vars from the base file (e.g., DATABASE_URL pointing at db, EMAIL_HOST=mailpit, optional REDIS_URL, etc.), which can break the devcontainer unless the user hand-edits .env. Consider removing environment from the override entirely, or duplicating/retaining the base environment entries in the override so the merged config stays functional out-of-the-box.

Suggested change

- DEBUG=True

DEBUG: "True"

Disable Poetry virtualenv creation in postCreateCommand to ensure consistent interpreter path, and remove redundant environment override from compose file since Docker Compose merges environment entries.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Add initializeCommand to copy .env.example when .env is missing so devcontainer starts without manual setup. Add tests to verify rendered devcontainer JSON and YAML are valid across all option combinations.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+  "workspaceFolder": "/app",
+  "initializeCommand": "if [ ! -f .env ] && [ -f .env.example ]; then cp .env.example .env; fi",
+  "forwardPorts": [


+    }
+  },
+  "postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry config virtualenvs.create false --local && poetry install && python manage.py migrate{% endif %}"


* main: chore(deps): upgrade all dev and CI dependencies (#58)

- Replace initializeCommand with onCreateCommand so .env copy runs inside the container (Linux shell), fixing Windows host portability - Switch Poetry from virtualenvs.create=false --local to virtualenvs.in-project=true so the venv lands at /app/.venv, avoiding permission failures with the non-root container user and preventing poetry.toml from dirtying the generated project - Unify python.defaultInterpreterPath to /app/.venv/bin/python for both uv and Poetry since both now use an in-project venv - Update test to assert the new unified interpreter path

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,50 @@
+{
+  "name": "{{ project_name }}",


project_name was interpolated raw into a quoted JSON string, so a name containing double-quotes would produce invalid devcontainer.json. Switch to the tojson filter so Jinja handles escaping correctly. Add a regression test that asserts names with quotes round-trip through json.loads without error.

* main: fix(template): align vite service node image with Dockerfile chore(deps): upgrade dependencies chore(template): bump django-celery-beat to 2.9+ for Django 6.0 support (#67)

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

+      }
+    }
+  },
+  "postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry config virtualenvs.in-project true && poetry install && poetry run python manage.py migrate{% endif %}"


feat(template): Add VSCode devcontainers

889b5b2

Copilot AI review requested due to automatic review settings March 8, 2026 01:27

Copilot started reviewing on behalf of CuriousLearner March 8, 2026 01:27 View session

Copilot AI reviewed Mar 8, 2026

View reviewed changes

fix(template): address code review feedback on devcontainer files

8ef0fca

Disable Poetry virtualenv creation in postCreateCommand to ensure consistent interpreter path, and remove redundant environment override from compose file since Docker Compose merges environment entries.

CuriousLearner requested a review from Copilot March 9, 2026 03:57

Copilot started reviewing on behalf of CuriousLearner March 9, 2026 03:57 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

Comment thread template/.devcontainer/devcontainer.json.jinja

Comment thread template/.devcontainer/devcontainer.json.jinja

fix(template): add .env bootstrap and devcontainer validation tests

76a0d23

Add initializeCommand to copy .env.example when .env is missing so devcontainer starts without manual setup. Add tests to verify rendered devcontainer JSON and YAML are valid across all option combinations.

Copilot AI review requested due to automatic review settings March 14, 2026 21:09

CuriousLearner force-pushed the vscode-devcontainers branch from 4faca52 to 76a0d23 Compare March 14, 2026 21:09

Copilot started reviewing on behalf of CuriousLearner March 14, 2026 21:10 View session

Copilot AI reviewed Mar 14, 2026

View reviewed changes

CuriousLearner added 2 commits May 3, 2026 01:46

Merge branch 'main' into vscode-devcontainers

2ad42b5

* main: chore(deps): upgrade all dev and CI dependencies (#58)

Copilot AI review requested due to automatic review settings May 2, 2026 20:32

Copilot started reviewing on behalf of CuriousLearner May 2, 2026 20:33 View session

Copilot AI reviewed May 2, 2026

View reviewed changes

Comment thread template/.devcontainer/devcontainer.json.jinja Outdated

@@ -0,0 +1,50 @@

{

"name": "{{ project_name }}",

CuriousLearner added 2 commits May 3, 2026 02:20

Merge branch 'main' into vscode-devcontainers

015c351

* main: fix(template): align vite service node image with Dockerfile chore(deps): upgrade dependencies chore(template): bump django-celery-beat to 2.9+ for Django 6.0 support (#67)

Copilot AI review requested due to automatic review settings June 7, 2026 06:46

Copilot started reviewing on behalf of CuriousLearner June 7, 2026 06:46 View session

Copilot AI reviewed Jun 7, 2026

View reviewed changes

Comment thread template/.devcontainer/devcontainer.json.jinja

}

}

},

"postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry config virtualenvs.in-project true && poetry install && poetry run python manage.py migrate{% endif %}"

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(template): Add VSCode devcontainers#43

feat(template): Add VSCode devcontainers#43
CuriousLearner wants to merge 7 commits into
mainfrom
vscode-devcontainers

CuriousLearner commented Mar 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI Mar 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	"postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry install && python manage.py migrate{% endif %}"
	"postCreateCommand": "{% if dependency_manager == 'uv' %}uv sync && uv run python manage.py migrate{% else %}poetry config virtualenvs.create false --local && poetry install && python manage.py migrate{% endif %}"

Uh oh!

Conversation

CuriousLearner commented Mar 8, 2026

Summary

Related Issues

Type of Change

What Changed

Additional Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants