moby--moby/docs/Makefile

.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate

# env vars passed through directly to Docker's build scripts
# to allow things like `make BUILDFLAGS=... binary` easily
# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these
DOCKER_ENVS := \
	-e BUILDFLAGS \
	-e DOCKER_GRAPHDRIVER \
	-e TESTDIRS \
	-e TESTFLAGS \
	-e TIMEOUT
# note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds

# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs)
DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))

# to allow `make DOCSPORT=9000 docs`
DOCSPORT := 8000

# Get the IP ADDRESS
DOCKER_IP=$(shell python -c "import urlparse ; print urlparse.urlparse('$(DOCKER_HOST)').hostname or ''")
HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER_IP)")
HUGO_BIND_IP=0.0.0.0

GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g")
DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))

DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE

# for some docs workarounds (see below in "docs-build" target)
GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null)

default: docs

docs: docs-build
	$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)

docs-draft: docs-build
	$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --buildDrafts="true" --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)


docs-shell: docs-build
	$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash


docs-build:
#	( git remote | grep -v upstream ) || git diff --name-status upstream/release..upstream/docs ./ > ./changed-files
#	echo "$(GIT_BRANCH)" > GIT_BRANCH
#	echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET
#	echo "$(GITCOMMIT)" > GITCOMMIT
	docker build -t "$(DOCKER_DOCS_IMAGE)" .
retooling for hugo Tweaking for Hugo Updating the Dockerfile with new sed; fix broken link on Kitematic Fixing image pull for Dockerfile Removing docs targets Signed-off-by: Mary Anthony <mary@docker.com> 2015-06-07 23:07:20 -04:00			`.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate`

			`# env vars passed through directly to Docker's build scripts`
Build two binaries client and daemon. Add a proxy to support 'docker daemon' Fix configFile option, and remove a test that is no longer relevant. Remove daemon build tag. Remove DOCKER_CLIENTONLY from build scripts. Signed-off-by: Daniel Nephin <dnephin@docker.com> Change docker-daemon to dockerd. Signed-off-by: Daniel Nephin <dnephin@docker.com> 2016-02-19 17:42:51 -05:00			# to allow things like `make BUILDFLAGS=... binary` easily
retooling for hugo Tweaking for Hugo Updating the Dockerfile with new sed; fix broken link on Kitematic Fixing image pull for Dockerfile Removing docs targets Signed-off-by: Mary Anthony <mary@docker.com> 2015-06-07 23:07:20 -04:00			# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these
			`DOCKER_ENVS := \`
			`-e BUILDFLAGS \`
			`-e DOCKER_GRAPHDRIVER \`
			`-e TESTDIRS \`
			`-e TESTFLAGS \`
			`-e TIMEOUT`
			`# note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds`

			# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs)
			`DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))`

			# to allow `make DOCSPORT=9000 docs`
			`DOCSPORT := 8000`

			`# Get the IP ADDRESS`
			`DOCKER_IP=$(shell python -c "import urlparse ; print urlparse.urlparse('$(DOCKER_HOST)').hostname or ''")`
			`HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost \|\| echo "$(DOCKER_IP)")`
			`HUGO_BIND_IP=0.0.0.0`

			`GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)`
fix docs not building if branch-name contains slashes similar to the changes made in a4192471cd6d6012a66c19a635a11c7f6139d683, clean the branch-name before using it as a tag-name for the image that's built. this also changes the "image name" for docs images being built from "docs-base" to "docker-docs", to be in line with the main Makefile before this change: /usr/bin/make -C docs docs docker build -t "docs-base:docs/slashes" . invalid value "docs-base:docs/slashes" for flag -t: Error parsing reference: "docs-base:docs/slashes" is not a valid repository/tag See 'docker build --help'. make[1]: * [docs-build] Error 125 make: * [docs] Error 2 after this change: /usr/bin/make -C docs docs docker build -t "docker-docs:docs-slashes" . Sending build context to Docker daemon 9.165 MB ... Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2016-05-22 11:30:41 -04:00			`GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) \| sed -e "s/[^[:alnum:]]/-/g")`
			`DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))`
retooling for hugo Tweaking for Hugo Updating the Dockerfile with new sed; fix broken link on Kitematic Fixing image pull for Dockerfile Removing docs targets Signed-off-by: Mary Anthony <mary@docker.com> 2015-06-07 23:07:20 -04:00
			`DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE`

			`# for some docs workarounds (see below in "docs-build" target)`
			`GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null)`

			`default: docs`

			`docs: docs-build`
			`$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)`

			`docs-draft: docs-build`
			`$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --buildDrafts="true" --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)`


			`docs-shell: docs-build`
			`$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash`


			`docs-build:`
			`# ( git remote \| grep -v upstream ) \|\| git diff --name-status upstream/release..upstream/docs ./ > ./changed-files`
			`# echo "$(GIT_BRANCH)" > GIT_BRANCH`
			`# echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET`
			`# echo "$(GITCOMMIT)" > GITCOMMIT`
			`docker build -t "$(DOCKER_DOCS_IMAGE)" .`