Merge pull request moby#3471 from zwpaper/dev-toc-ci

ci: add ci to check README toc

Author: crazy-max

README.md

@@ -42,7 +42,6 @@ Join `#buildkit` channel on [Docker Community Slack](https://dockr.ly/comm-slack
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [Used by](#used-by)
 - [Quick start](#quick-start)
   - [Starting the `buildkitd` daemon](#starting-the-buildkitd-daemon)

hack/dockerfiles/generated-files.Dockerfile

@@ -1,6 +1,7 @@
 # syntax=docker/dockerfile-upstream:master
 
 ARG GO_VERSION="1.19"
+ARG NODE_VERSION="19"
 ARG PROTOC_VERSION="3.11.4"
 
 # protoc is dynamically linked to glibc so can't use alpine base
@@ -53,3 +54,24 @@ RUN --mount=type=bind,target=.,rw \
     exit 1
   fi
 EOT
+
+FROM node:${NODE_VERSION}-alpine AS doctoc
+RUN npm install -g doctoc
+WORKDIR /buildkit
+RUN --mount=type=bind,target=.,rw <<EOT
+  doctoc README.md
+  mkdir /out
+  cp README.md /out/
+EOT
+
+FROM base AS validate-toc
+RUN --mount=type=bind,target=.,rw \
+    --mount=type=bind,from=doctoc,source=/out/README.md,target=./README.md <<EOT
+  set -e
+  diff=$(git status --porcelain -- 'README.md')
+  if [ -n "$diff" ]; then
+    echo >&2 'ERROR: The result of "doctoc" differs. Please update with "doctoc README.md"'
+    echo "$diff"
+    exit 1
+  fi
+EOT

hack/validate-generated-files

@@ -8,3 +8,9 @@ buildxCmd build \
   --output "type=cacheonly" \
   --file "./hack/dockerfiles/generated-files.Dockerfile" \
   .
+
+buildxCmd build \
+  --target "validate-toc" \
+  --output "type=cacheonly" \
+  --file "./hack/dockerfiles/generated-files.Dockerfile" \
+  .