diff options
| author | Chuck Lantz <clantz@microsoft.com> | 2021-08-25 05:00:20 +0300 |
|---|---|---|
| committer | Chuck Lantz <clantz@microsoft.com> | 2021-08-25 05:00:20 +0300 |
| commit | b05c4cabbfaaaacdc46186ef7bb8ceca153e081e (patch) | |
| tree | f5faa8acba81573738394c1dc950cb9c3e1ca819 /.devcontainer/cache | |
| parent | 0b7c156506f1a1edd8aba4cf1cd653ac7e435bd8 (diff) | |
Comment tweaks
Diffstat (limited to '.devcontainer/cache')
| -rwxr-xr-x | .devcontainer/cache/build-cache-image.sh | 6 | ||||
| -rw-r--r-- | .devcontainer/cache/cache.Dockerfile | 7 | ||||
| -rwxr-xr-x | .devcontainer/cache/restore-diff.sh | 7 |
3 files changed, 10 insertions, 10 deletions
diff --git a/.devcontainer/cache/build-cache-image.sh b/.devcontainer/cache/build-cache-image.sh index 9aee60fe5c1..865b860898c 100755 --- a/.devcontainer/cache/build-cache-image.sh +++ b/.devcontainer/cache/build-cache-image.sh @@ -1,8 +1,8 @@ #!/bin/bash -# This file simply wraps the dockeer build command used to build the image with the -# cached result of the commands from "prepare.sh" and pushes it to the specified -# container image registry. +# This file simply wraps the docker build command to build an image that includes +# a cache.tar file with the result of "prepare.sh" inside of it. See cache.Dockerfile +# for the steps that are actually taken to do this. set -e diff --git a/.devcontainer/cache/cache.Dockerfile b/.devcontainer/cache/cache.Dockerfile index c1af3337c2f..a2c2866fe23 100644 --- a/.devcontainer/cache/cache.Dockerfile +++ b/.devcontainer/cache/cache.Dockerfile @@ -1,7 +1,7 @@ -# This dockerfile is used to build up from a base image to create an image with cached results of running "prepare.sh". +# This dockerfile is used to build up from a base image to create an image a cache.tar file containing the results of running "prepare.sh". # Other image contents: https://github.com/microsoft/vscode-dev-containers/blob/master/repository-containers/images/github.com/microsoft/vscode/.devcontainer/base.Dockerfile -# First stage generates the cache tar +# This first stage generates cache.tar FROM mcr.microsoft.com/vscode/devcontainers/repos/microsoft/vscode:dev as cache ARG USERNAME=node COPY --chown=${USERNAME}:${USERNAME} . /repo-source-tmp/ @@ -13,7 +13,8 @@ RUN mkdir /usr/local/etc/devcontainer-cache \ && .devcontainer/prepare.sh \ && .devcontainer/cache/cache-diff.sh" -# Second stage is the acual output that includes only the tar - restore-diff.sh is then fired on postCreateCommand to expand it +# This second stage starts fresh and just copies in cache.tar from the previous stage. The related +# devcontainer.json file is then setup to have postCreateCommand fire restore-diff.sh to expand it. FROM mcr.microsoft.com/vscode/devcontainers/repos/microsoft/vscode:dev as dev-container ARG USERNAME=node ARG CACHE_FOLDER="/usr/local/etc/devcontainer-cache" diff --git a/.devcontainer/cache/restore-diff.sh b/.devcontainer/cache/restore-diff.sh index 88e25062fa5..827afc45ab1 100755 --- a/.devcontainer/cache/restore-diff.sh +++ b/.devcontainer/cache/restore-diff.sh @@ -1,9 +1,8 @@ #!/usr/bin/env bash -# This file restores the results of the "prepare.sh" into their proper locations -# once the container has been created. It runs as a postCreateCommand which -# in GitHub Codespaces occurs parallel to other startup activities and does not -# really add to the overal startup time given how quick the operation ends up being. +# This file expands the cache.tar file in the image that contains the results of "prepare.sh" +# on top of the source tree. It runs as a postCreateCommand which runs after the container/codespace +# is already up where you would typically run a command like "yarn install". set -e |