You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Switch devcontainer.json from prebuilt GHCR image to local builds as
the default. This ensures the template works out of the box for forks
and new projects without depending on a pre-existing GHCR image.
The prebuilt image is preserved as a commented-out option with
instructions in the README for enabling it, including the requirement
to make the GHCR package public (private by default).
Copy file name to clipboardExpand all lines: README.md
+9-14Lines changed: 9 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,21 +57,20 @@ source .claude/activate.sh
57
57
58
58
See [.claude/README.md](.claude/README.md) for detailed information about the Claude Code configuration.
59
59
60
-
# Devcontainer Prebuilt Image
60
+
# Devcontainer
61
61
62
-
This template includes a CI workflow (`.github/workflows/devcontainer.yml`) that automatically builds and pushes a devcontainer image to GitHub Container Registry (GHCR) whenever `.devcontainer/` files change on `main`.
62
+
By default, the devcontainer builds locally from `.devcontainer/Dockerfile`. This works out of the box for all users, including forks and projects created from this template.
63
63
64
-
The main `.devcontainer/devcontainer.json` references this prebuilt image to avoid slow local builds:
A CI workflow (`.github/workflows/devcontainer.yml`) automatically builds and pushes a devcontainer image to GHCR whenever `.devcontainer/` files change on `main`. To use it for faster startup:
71
67
72
-
**GHCR packages are private by default.** After the first CI push, you must manually make the package public or users (and tools like DevPod) will get a `MANIFEST_UNKNOWN` error when trying to pull the image.
68
+
1. Edit `.devcontainer/devcontainer.json`: comment out the `"build"` and `"features"` blocks, uncomment the `"image"` line
69
+
2. Update the image reference to match your repo: `ghcr.io/<owner>/<repo>/devcontainer:latest`
70
+
3. Push to `main` and wait for the CI workflow to complete
71
+
4.**Make the GHCR package public** (see below) — GHCR packages are private by default and will fail with `MANIFEST_UNKNOWN` otherwise
gh api --method PATCH /user/packages/container/<repo>%2Fdevcontainer -f visibility=public
91
90
```
92
91
93
-
## Falling back to local builds
94
-
95
-
If the prebuilt image is unavailable, you can switch to local builds by editing `.devcontainer/devcontainer.json`: comment out the `"image"` line and uncomment the `"build"` and `"features"` blocks.
96
-
97
92
# Github setup
98
93
99
94
There are github workflows for CI, codecov and automated pypi publishing in `ci.yml` and `publish.yml`.
0 commit comments