Simpler approach building spec.md

ndeloof · ndeloof · commit 12c2232eb4cc · 2023-03-21T16:42:40.000+01:00
Signed-off-by: Nicolas De Loof &lt;nicolas.deloof@gmail.com&gt;
diff --git a/01-status.md b/01-status.md
@@ -22,3 +22,4 @@ to support those running modes:
 * default: warn user about unsupported attributes, but ignore them
 * strict: warn user about unsupported attributes and reject the compose file
 * loose: ignore unsupported attributes AND unknown attributes (that were not defined by the spec by the time implementation was created)
+
diff --git a/02-model.md b/02-model.md
@@ -105,3 +105,4 @@ Secrets and configs are read-only. The volume configuration allows you to select
 to tweak volume management according to the actual infrastructure. Configs and Secrets rely on platform services,
 and are declared `external` as they are not managed as part of the application lifecycle: the Compose implementation
 will use a platform-specific lookup mechanism to retrieve runtime values.
+
diff --git a/03-compose-file.md b/03-compose-file.md
@@ -76,3 +76,4 @@ services:
 - If Compose implementation is executed with `zot` as explicit service to run and profile `test` enabled,
   profile `debug` is automatically enabled and service `bar` is pulled in as a dependency starting both
   services `zot` and `bar`.
+
diff --git a/04-version-and-name.md b/04-version-and-name.md
@@ -26,3 +26,4 @@ services:
       - COMPOSE_PROJECT_NAME
     command: echo "I'm running ${COMPOSE_PROJECT_NAME}"
 ```
+
diff --git a/05-services.md b/05-services.md
@@ -1695,3 +1695,4 @@ volumes_from:
 ### working_dir
 
 `working_dir` overrides the container's working directory from that specified by image (i.e. Dockerfile `WORKDIR`).
+
diff --git a/06-networks.md b/06-networks.md
@@ -205,3 +205,4 @@ networks:
     external: true
     name: "${NETWORK_ID}"
 ```
+
diff --git a/07-volumes.md b/07-volumes.md
@@ -127,3 +127,4 @@ volumes:
       name: ${DATABASE_VOLUME}
 ```
 
+
diff --git a/08-configs.md b/08-configs.md
@@ -56,3 +56,4 @@ If `external` is set to `true` and secret configuration has other but `name` att
 not managed by compose lifecycle, Compose Implementations SHOULD reject a Compose file as invalid.
 
 Compose file need to explicitly grant access to the configs to relevant services in the application.
+
diff --git a/09-secrets.md b/09-secrets.md
@@ -56,3 +56,4 @@ not managed by compose lifecycle, Compose Implementations SHOULD reject a Compos
 
 Compose file need to explicitly grant access to the secrets to relevant services in the application.
 
+
diff --git a/10-fragments.md b/10-fragments.md
@@ -32,3 +32,4 @@ volumes:
     <<: *default-volume
     name: "metrics"
 ```
+
diff --git a/11-extension.md b/11-extension.md
@@ -83,4 +83,4 @@ Value can can combine multiple values and using without separator.
   40s
   1m30s
   1h5m30s20ms
-```
+```
diff --git a/12-interpolation.md b/12-interpolation.md
@@ -42,4 +42,4 @@ If the Compose implementation can't resolve a substituted variable and no defaul
 the user and substitute the variable with an empty string.
 
 As any values in a Compose file can be interpolated with variable substitution, including compact string notation
-for complex elements, interpolation MUST be applied _before_ merge on a per-file-basis.
+for complex elements, interpolation MUST be applied _before_ merge on a per-file-basis.
diff --git a/Dockerfile b/Dockerfile
@@ -8,15 +8,25 @@ RUN jsonschema2md -d /schema/ -e json
 FROM scratch as docs
 COPY --from=generator /out /
 
-FROM --platform=${BUILDPLATFORM} node:19.6.1-alpine as spec-build
-RUN apk add --no-cache rsync git
-RUN npm install -g markdown-include
+FROM --platform=${BUILDPLATFORM} alpine as spec-build
 WORKDIR /src
-RUN --mount=target=/context \
-    --mount=target=.,type=tmpfs <<EOT
+COPY *.md /src
+RUN <<EOT
   set -e
-  rsync -a /context/. .
-  markdown-include markdown-include.json
+  cat head.md > spec.md
+  cat 01-status.md >> spec.md
+  cat 02-model.md >> spec.m >> spec.md
+  cat 03-compose-file.md >> spec.md
+  cat 04-version-and-name.md >> spec.md
+  cat 05-services.md >> spec.md
+  cat 06-networks.md >> spec.md
+  cat 07-volumes.md >> spec.md
+  cat 08-configs.md >> spec.md
+  cat 09-secrets.md >> spec.md
+  cat 10-fragments.md >> spec.md
+  cat 11-extension.md >> spec.md
+  cat 12-interpolation.md >> spec.md
+
   mkdir /out
   cp spec.md /out
 EOT
diff --git a/build.md b/build.md
@@ -493,3 +493,4 @@ services:
 
 * [docker-compose](https://docs.docker.com/compose)
 * [buildX bake](https://docs.docker.com/buildx/working-with-buildx/)
+
diff --git a/head.md b/head.md
@@ -0,0 +1,10 @@
+<!---
+This file is generated, changes will be overwritten or CI specification check will fail
+All changes should be done in the markdown files located in the spec directory
+-->
+# The Compose Specification
+{:.no_toc}
+
+* ToC
+  {:toc}
+
diff --git a/spec.md b/spec.md
@@ -2553,15 +2553,15 @@ Interpolation can also be nested:
 Other extended shell-style features, such as `${VARIABLE/foo/bar}`, are not
 supported by the Compose specification.
 
-You can use a `$` (double-dollar sign) when your configuration needs a literal
-dollar sign. This also prevents Compose from interpolating a value, so a `$`
+You can use a `$$` (double-dollar sign) when your configuration needs a literal
+dollar sign. This also prevents Compose from interpolating a value, so a `$$`
 allows you to refer to environment variables that you don't want processed by
 Compose.
 
 ```yml
 web:
   build: .
-  command: "$VAR_NOT_INTERPOLATED_BY_COMPOSE"
+  command: "$$VAR_NOT_INTERPOLATED_BY_COMPOSE"
 ```
 
 If the Compose implementation can't resolve a substituted variable and no default value is defined, it MUST warn
diff --git a/spec.template.md b/spec.template.md

Original file line number	Diff line number	Diff line change
`@@ -1695,3 +1695,4 @@ volumes_from:`
`1695`	`1695`	`### working_dir`
`1696`	`1696`
`1697`	`1697`	`working_dir` overrides the container's working directory from that specified by image (i.e. Dockerfile `WORKDIR`).
	`1698`	`+`
Original file line number	Diff line number	Diff line change
`@@ -127,3 +127,4 @@ volumes:`
`127`	`127`	`name: ${DATABASE_VOLUME}`
`128`	`128`	```
`129`	`129`
	`130`	`+`
Original file line number	Diff line number	Diff line change
@@ -56,3 +56,4 @@ If `external` is set to `true` and secret configuration has other but `name` att
`56`	`56`	`not managed by compose lifecycle, Compose Implementations SHOULD reject a Compose file as invalid.`
`57`	`57`
`58`	`58`	`Compose file need to explicitly grant access to the configs to relevant services in the application.`
	`59`	`+`
Original file line number	Diff line number	Diff line change
`@@ -56,3 +56,4 @@ not managed by compose lifecycle, Compose Implementations SHOULD reject a Compos`
`56`	`56`
`57`	`57`	`Compose file need to explicitly grant access to the secrets to relevant services in the application.`
`58`	`58`
	`59`	`+`