helm-external-secrets/hack/api-docs/Makefile

# Copyright 2019 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

DOCKER ?= docker
MKDOCS_IMAGE ?= eso-mkdocs:latest
MKDOCS ?= mkdocs
MIKE ?= mike
DOCS_VERSION ?= main
VERSION_NO_V ?= $(shell echo $(DOCS_VERSION) | cut -d'v' -f2)
MAJOR_VERSION ?= $(shell echo $(VERSION_NO_V) | cut -d'.' -f1)
MINOR_VERSION ?= $(shell echo $(VERSION_NO_V) | cut -d'.' -f2)
DOCS_ALIAS ?= unstable
GITHUB_TOKEN ?= invalid
SERVE_BIND_ADDRESS ?= 127.0.0.1
SHELL := /usr/bin/env bash

# TOP is the current directory where this Makefile lives.
TOP := $(dir $(firstword $(MAKEFILE_LIST)))
# ROOT is the repository root.
ROOT := $(abspath $(TOP))/../../
SRCDIR := $(ROOT)/docs
CFGFILE := $(ROOT)/hack/api-docs/mkdocs.yml
# GENROOT is the root of the generated documentation.
GENROOT := $(ROOT)/site
GEN_CRD_API_REFERENCE_DOCS ?= $(ROOT)/bin/gen-crd-api-reference-docs

# Grab the uid/gid to fix permissions due to running in a docker container.
GID := $(shell id -g)
UID := $(shell id -u)
GIT_DIR := $(shell git rev-parse --path-format=absolute --git-dir)
GIT_COMMON_DIR := $(shell git rev-parse --path-format=absolute --git-common-dir)
GIT_MOUNT := $(if $(filter $(GIT_DIR),$(GIT_COMMON_DIR)),,--mount type=bind,source=$(GIT_COMMON_DIR),target=$(GIT_COMMON_DIR))

# SOURCES is a list of a source files used to generate the documentation.
SOURCES := $(shell find $(SRCDIR) -name \*.md)
SOURCES += mkdocs.yml Makefile

# entrypoint
all: build

.PHONY: image
image:
	$(DOCKER) buildx build --load -t $(MKDOCS_IMAGE) -f Dockerfile .

VERSION_TO_UPDATE ?= $(shell echo $(MAJOR_VERSION).$(MINOR_VERSION).x)

.PHONY: stability-support.update
stability-support.update:
	ROOT=$(ROOT) ./add_eso_version.sh $(VERSION_TO_UPDATE)

.PHONY: build
build: image generate $(SOURCES)
	mkdir -p $(GENROOT)
	$(DOCKER) run \
	    --mount type=bind,source=$(ROOT),target=/repo \
	    $(GIT_MOUNT) \
		--sig-proxy=true \
		--rm \
		--user $(UID):$(GID) \
		--env "GIT_COMMITTER_NAME=$(shell git config user.name)" \
		--env "GIT_COMMITTER_EMAIL=$(shell git config user.email)" \
		--env "GITHUB_TOKEN=$(GITHUB_TOKEN)" \
		$(MKDOCS_IMAGE) \
		$(SHELL) -c "cd /repo && $(MIKE) deploy --ignore-remote-status --update-aliases -F hack/api-docs/mkdocs.yml $(DOCS_VERSION) $(DOCS_ALIAS);"
.PHONY: build.publish
build.publish: image generate $(SOURCES)
	mkdir -p $(GENROOT)
	$(DOCKER) run \
	    --mount type=bind,source=$(ROOT),target=/repo \
	    $(GIT_MOUNT) \
		--sig-proxy=true \
		--rm \
		--user $(UID):$(GID) \
		--env "GIT_COMMITTER_NAME=$(shell git config user.name)" \
		--env "GIT_COMMITTER_EMAIL=$(shell git config user.email)" \
		--env "GITHUB_TOKEN=$(GITHUB_TOKEN)" \
		$(MKDOCS_IMAGE) \
		$(SHELL) -c "cd /repo && $(MIKE) deploy --update-aliases -p -F hack/api-docs/mkdocs.yml $(DOCS_VERSION) $(DOCS_ALIAS);"
.PHONY: generate
generate: $(GEN_CRD_API_REFERENCE_DOCS)
	GEN_CRD_API_REFERENCE_DOCS=$(GEN_CRD_API_REFERENCE_DOCS) ./generate.sh $(SRCDIR)/api/spec.md

$(GEN_CRD_API_REFERENCE_DOCS): $(ROOT)/hack/tools/gen-crd-api-reference-docs/go.mod $(ROOT)/hack/tools/gen-crd-api-reference-docs/go.sum $(ROOT)/Makefile
	$(MAKE) -C $(ROOT) GEN_CRD_API_REFERENCE_DOCS=$(GEN_CRD_API_REFERENCE_DOCS) gen-crd-api-reference-docs

.PHONY: clean
clean:
	rm -r $(GENROOT)/* || true

# serve runs mkdocs as a local webserver for interactive development.
# This will serve the live copy of the docs on 127.0.0.1:8000.
.PHONY: serve
serve: image generate
	$(DOCKER) run \
		-it \
		--sig-proxy=true \
	    --mount type=bind,source=$(ROOT),target=/repo \
		--user $(UID):$(GID) \
		-p $(SERVE_BIND_ADDRESS):8000:8000 \
		--rm \
		$(MKDOCS_IMAGE) \
		$(SHELL) -c "cd /repo && mkdocs serve -f hack/api-docs/mkdocs.yml -a 0.0.0.0:8000 --livereload"