Add comment explaining variable usage in GHA step command

cisagov · Dec 2, 2020 · f525714 · f525714
1 parent ec77abe
commit f525714
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -125,6 +125,9 @@ jobs:
         run: |
           echo "GH_SHORT_SHA=${GITHUB_SHA::7}" >> $GITHUB_ENV
       - name: Build Docker image
+        # DOCKER_BUILDKIT=1 tells Docker to use BuildKit when building the
+        # image per:
+        # https://docs.docker.com/develop/develop-images/build_enhancements/
         run: |
           DOCKER_BUILDKIT=1 docker-compose build \
             --build-arg PY_VERSION=${{ matrix.python-version }} \

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,6 +17,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Build Docker image
+        # DOCKER_BUILDKIT=1 tells Docker to use BuildKit when building the
+        # image per:
+        # https://docs.docker.com/develop/develop-images/build_enhancements/
         run: |
           DOCKER_BUILDKIT=1 docker-compose build \
             --build-arg PY_VERSION=${{ matrix.python-version }} \