docker-cli/scripts/docs/generate-yaml.sh

#!/usr/bin/env bash

set -eu

: "${CLI_DOCS_TOOL_VERSION=v0.9.0}"

function clean() {
	rm -f go.mod
}

export GO111MODULE=auto
trap clean EXIT

./scripts/vendor init
# build docsgen
go build -mod=vendor -modfile=vendor.mod -tags docsgen -o /tmp/docsgen ./docs/generate/generate.go

mkdir -p docs/yaml
set -x
/tmp/docsgen --formats yaml --source "$(pwd)/docs/reference/commandline" --target "$(pwd)/docs/yaml"
Run docs and man generation in CI Also cleanup the scripts a bit to be more consistent, and fail on errors. Signed-off-by: Daniel Nephin <dnephin@docker.com> 2017-06-14 13:42:58 -07:00			`#!/usr/bin/env bash`

switch to cli-docs-tool for yaml docs generation Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> switch to cli-docs-tool and validate yamldocs Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> 2022-02-25 17:11:04 +01:00			`set -eu`
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com> 2017-05-10 18:24:32 -07:00
update cli-docs-tool to v0.9.0 Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2025-01-13 18:59:22 +01:00			`: "${CLI_DOCS_TOOL_VERSION=v0.9.0}"`
switch to cli-docs-tool for yaml docs generation Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> switch to cli-docs-tool and validate yamldocs Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> 2022-02-25 17:11:04 +01:00
docs: include required tools in source tree In order to be able to build the documentation without internet access (as is required by some distribution build systems), all of the source code needed for the build needs to be available in the source tarball. This used to be possible with the docker-cli sources but was accidentally broken with some CI changes that switched to downloading the tools (by modifying go.mod as part of the docs build script). This pattern also maked documentation builds less reproducible since the tool version used was not based on the source code version. Fixes: 7dc35c03fca5 ("validate manpages target") Fixes: a650f4ddd008 ("switch to cli-docs-tool for yaml docs generation") Signed-off-by: Aleksa Sarai <cyphar@cyphar.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2024-12-16 17:21:02 +11:00			`function clean() {`
			`rm -f go.mod`
switch to cli-docs-tool for yaml docs generation Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> switch to cli-docs-tool and validate yamldocs Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> 2022-02-25 17:11:04 +01:00			`}`

docs: include required tools in source tree In order to be able to build the documentation without internet access (as is required by some distribution build systems), all of the source code needed for the build needs to be available in the source tarball. This used to be possible with the docker-cli sources but was accidentally broken with some CI changes that switched to downloading the tools (by modifying go.mod as part of the docs build script). This pattern also maked documentation builds less reproducible since the tool version used was not based on the source code version. Fixes: 7dc35c03fca5 ("validate manpages target") Fixes: a650f4ddd008 ("switch to cli-docs-tool for yaml docs generation") Signed-off-by: Aleksa Sarai <cyphar@cyphar.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2024-12-16 17:21:02 +11:00			`export GO111MODULE=auto`
switch to cli-docs-tool for yaml docs generation Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> switch to cli-docs-tool and validate yamldocs Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> 2022-02-25 17:11:04 +01:00			`trap clean EXIT`

docs: include required tools in source tree In order to be able to build the documentation without internet access (as is required by some distribution build systems), all of the source code needed for the build needs to be available in the source tarball. This used to be possible with the docker-cli sources but was accidentally broken with some CI changes that switched to downloading the tools (by modifying go.mod as part of the docs build script). This pattern also maked documentation builds less reproducible since the tool version used was not based on the source code version. Fixes: 7dc35c03fca5 ("validate manpages target") Fixes: a650f4ddd008 ("switch to cli-docs-tool for yaml docs generation") Signed-off-by: Aleksa Sarai <cyphar@cyphar.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2024-12-16 17:21:02 +11:00			`./scripts/vendor init`
			`# build docsgen`
			`go build -mod=vendor -modfile=vendor.mod -tags docsgen -o /tmp/docsgen ./docs/generate/generate.go`
switch to cli-docs-tool for yaml docs generation Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> switch to cli-docs-tool and validate yamldocs Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> 2022-02-25 17:11:04 +01:00
			`mkdir -p docs/yaml`
			`set -x`
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2023-01-06 19:04:05 +01:00			`/tmp/docsgen --formats yaml --source "$(pwd)/docs/reference/commandline" --target "$(pwd)/docs/yaml"`