Add devcontainer for docs #385
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -350,4 +350,3 @@ MigrationBackup/ | |
|
|
||
| .idea | ||
| .DS_Store | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # [Choice] Debian OS version (use bullseye on local arm64/Apple Silicon): bullseye, buster | ||
| ARG VARIANT=bullseye | ||
| FROM mcr.microsoft.com/vscode/devcontainers/jekyll:0-${VARIANT} | ||
|
|
||
| # [Choice] Node.js version: none, lts/*, 16, 14, 12, 10 | ||
| ARG NODE_VERSION="none" | ||
| RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi | ||
|
|
||
| # [Optional] Uncomment this section to install additional OS packages. | ||
| # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ | ||
| # && apt-get -y install --no-install-recommends <your-package-list-here> | ||
|
|
||
| # [Optional] Uncomment this line to install global node packages. | ||
| # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1 |
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
| @@ -0,0 +1,26 @@ | ||||
| # [Choice] Debian OS version (use 2.7-bullseye on local arm64/Apple Silicon): 2.7-bullseye, 2.7-buster | ||||
| ARG VARIANT=2.7-bullseye | ||||
| FROM mcr.microsoft.com/vscode/devcontainers/ruby:${VARIANT} | ||||
| COPY library-scripts/meta.env /usr/local/etc/vscode-dev-containers | ||||
|
|
||||
| # ENV Variables required by Jekyll | ||||
| ENV LANG=en_US.UTF-8 \ | ||||
| LANGUAGE=en_US:en \ | ||||
| TZ=Etc/UTC \ | ||||
| LC_ALL=en_US.UTF-8 \ | ||||
| LANG=en_US.UTF-8 \ | ||||
|
There was a problem hiding this comment. The LANG environment variable is set twice (lines 7 and 11) with the same value. The duplicate on line 11 should be removed.
Suggested change
|
||||
| LANGUAGE=en_US | ||||
|
|
||||
| # Install bundler, latest jekyll, and github-pages for older jekyll | ||||
| RUN gem install bundler jekyll github-pages | ||||
|
|
||||
| # [Choice] Node.js version: none, lts/*, 16, 14, 12, 10 | ||||
| ARG NODE_VERSION="none" | ||||
| RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi | ||||
|
|
||||
| # [Optional] Uncomment this section to install additional OS packages. | ||||
| # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ | ||||
| # && apt-get -y install --no-install-recommends <your-package-list-here> | ||||
|
|
||||
| # [Optional] Uncomment this line to install global node packages. | ||||
| # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1 | ||||
|
Comment on lines
+1
to
+26
There was a problem hiding this comment. The base.Dockerfile file is not referenced anywhere in the devcontainer configuration. The devcontainer.json uses "Dockerfile" (not "base.Dockerfile"), and Dockerfile doesn't reference base.Dockerfile either. This file appears to be unused and should either be removed or properly integrated into the build configuration if it was intended to be used. |
||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,35 @@ | ||||||
| // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: | ||||||
| // https://github.com/microsoft/vscode-dev-containers/tree/v0.205.2/containers/jekyll | ||||||
|
There was a problem hiding this comment. The reference URL points to the deprecated vscode-dev-containers repository at a specific old version (v0.205.2 from 2021). Microsoft deprecated this repository in favor of the devcontainers organization. While the URL may still work for reference, consider updating to point to current documentation at https://containers.dev or https://github.com/devcontainers/templates for a more future-proof reference.
Suggested change
Member
There was a problem hiding this comment. |
||||||
| { | ||||||
| "name": "Jekyll", | ||||||
| "build": { | ||||||
| "dockerfile": "Dockerfile", | ||||||
| "args": { | ||||||
| // Update 'VARIANT' to pick a Debian OS version: bullseye, buster | ||||||
| // Use bullseye when on local arm64/Apple Silicon. | ||||||
| "VARIANT": "bullseye", | ||||||
| // Enable Node.js: pick the latest LTS version | ||||||
| "NODE_VERSION": "lts/*" | ||||||
| } | ||||||
|
There was a problem hiding this comment. Trailing whitespace after the closing brace. This should be removed for consistency.
Suggested change
|
||||||
| }, | ||||||
|
|
||||||
| // Set *default* container specific settings.json values on container create. | ||||||
| "settings": {}, | ||||||
|
|
||||||
| // Add the IDs of extensions you want installed when the container is created. | ||||||
| "extensions": [], | ||||||
|
|
||||||
| // Use 'forwardPorts' to make a list of ports inside the container available locally. | ||||||
| "forwardPorts": [ | ||||||
| // Jekyll server | ||||||
| 4000, | ||||||
| // Live reload server | ||||||
| 35729 | ||||||
| ], | ||||||
|
|
||||||
| // Use 'postCreateCommand' to run commands after the container is created. | ||||||
| "postCreateCommand": "sh .devcontainer/post-create.sh", | ||||||
|
|
||||||
| // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | ||||||
| "remoteUser": "vscode" | ||||||
| } | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,12 @@ | ||||||
| #!/bin/sh | ||||||
|
|
||||||
| # Install the version of Bundler. | ||||||
| if [ -f Gemfile.lock ] && grep "BUNDLED WITH" Gemfile.lock > /dev/null; then | ||||||
| cat Gemfile.lock | tail -n 2 | grep -C2 "BUNDLED WITH" | tail -n 1 | xargs gem install bundler -v | ||||||
|
There was a problem hiding this comment. The command pipeline to extract the bundler version is overly complex and potentially fragile. The use of "grep -C2" (2 context lines) followed by "tail -n 1" to get the version number is convoluted. A simpler and more robust approach would be: "grep -A 1 'BUNDLED WITH' Gemfile.lock | tail -n 1 | xargs gem install bundler -v". This eliminates the unnecessary "cat" and the confusing use of context lines.
Suggested change
|
||||||
| fi | ||||||
|
|
||||||
| # If there's a Gemfile, then run `bundle install` | ||||||
| # It's assumed that the Gemfile will install Jekyll too | ||||||
| if [ -f Gemfile ]; then | ||||||
| bundle install | ||||||
| fi | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| * text=auto | ||
|
|
||
| *.sh text eol=lf |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| // See https://go.microsoft.com/fwlink/?LinkId=733558 | ||
| // for the documentation about the tasks.json format | ||
| "version": "2.0.0", | ||
| "tasks": [ | ||
| { | ||
| "label": "Serve", | ||
| "type": "shell", | ||
| "command": "bundle exec jekyll serve --livereload", | ||
| "group": { | ||
| "kind": "test", | ||
| "isDefault": true | ||
|
Comment on lines
+10
to
+12
There was a problem hiding this comment. The PR description states that contributors can "run the default task (F5)" but F5 is typically the keyboard shortcut for debugging/running, not for executing tasks. The "Serve" task is configured as a "test" task (not a build task), and default tasks are typically run via the Command Palette or Ctrl+Shift+P > "Tasks: Run Task" or Ctrl+Shift+B for build tasks. Consider either: 1) updating the PR description to reflect the correct way to run the task, or 2) changing the task configuration to use "kind": "build" instead of "kind": "test" so it can be run with Ctrl+Shift+B, or 3) adding a launch.json configuration that runs this task when F5 is pressed. |
||
| }, | ||
| "isBackground": true, | ||
|
There was a problem hiding this comment. Trailing comma after "isBackground: true" should be removed. JSON does not allow trailing commas in standard parsers, although some tools may be lenient. For consistency with the root .vscode/tasks.json which doesn't use trailing commas, and to ensure maximum compatibility, this should be removed. |
||
| }, | ||
| { | ||
| "label": "Build", | ||
| "type": "shell", | ||
| "command": "bundle exec jekyll build", | ||
| "group": { | ||
| "kind": "build", | ||
| "isDefault": true | ||
| }, | ||
| } | ||
|
There was a problem hiding this comment. Trailing comma after the closing brace should be removed. JSON does not allow trailing commas in standard parsers. For consistency with the root .vscode/tasks.json which doesn't use trailing commas, and to ensure maximum compatibility, this should be removed. |
||
| ] | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The base.Dockerfile references "library-scripts/meta.env" which does not exist in the repository. If this file is intended to be used (though it currently appears unused), this COPY instruction would fail during build.