mirror of
https://github.com/external-secrets/external-secrets.git
synced 2024-12-14 11:57:59 +00:00
87 lines
2.8 KiB
Makefile
87 lines
2.8 KiB
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 ?= github.com/external-secrets-mkdocs:latest
|
|
MKDOCS ?= mkdocs
|
|
MIKE ?= mike
|
|
DOCS_VERSION ?= main
|
|
DOCS_ALIAS ?= unstable
|
|
SERVE_BIND_ADDRESS ?= 127.0.0.1
|
|
|
|
# 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
|
|
|
|
# Grab the uid/gid to fix permissions due to running in a docker container.
|
|
GID := $(shell id -g)
|
|
UID := $(shell id -u)
|
|
|
|
# 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) build -t $(MKDOCS_IMAGE) --build-arg USER_ID=$(UID) -f Dockerfile .
|
|
|
|
.PHONY: build
|
|
build: image generate $(SOURCES)
|
|
mkdir -p $(GENROOT)
|
|
$(DOCKER) run \
|
|
--mount type=bind,source=$(ROOT),target=/repo \
|
|
--sig-proxy=true \
|
|
--rm \
|
|
--user $(UID):$(GID) \
|
|
$(MKDOCS_IMAGE) \
|
|
/bin/bash -c "cd /repo && git config user.email "docs@external-secrets.io" && git config user.name "Docs" && $(MIKE) deploy --ignore --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 \
|
|
--sig-proxy=true \
|
|
--rm \
|
|
--user $(UID):$(GID) \
|
|
$(MKDOCS_IMAGE) \
|
|
/bin/bash -c "cd /repo && git config user.email "docs@external-secrets.io" && git config user.name "Docs" && $(MIKE) deploy --update-aliases -p -F hack/api-docs/mkdocs.yml $(DOCS_VERSION) $(DOCS_ALIAS);"
|
|
.PHONY: generate
|
|
generate:
|
|
./generate.sh $(SRCDIR)/spec.md
|
|
|
|
.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:
|
|
$(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) \
|
|
/bin/bash -c "cd /repo && mkdocs serve -f hack/api-docs/mkdocs.yml -a 0.0.0.0:8000"
|