mirror of
https://github.com/docling-project/docling-serve.git
synced 2025-11-29 00:23:36 +00:00
ac3518c34c
to ensure the code maintenance. Thanks to docling project- took some good bits around python linting from the project. These checks are also added in the markdown, so that user can run these checks locally to recreate the errors. Signed-off-by: Anil Vishnoi <vishnoianil@gmail.com>
76 lines
2.9 KiB
Makefile
76 lines
2.9 KiB
Makefile
.PHONY: help
|
|
help:
|
|
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-18s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
|
|
|
#
|
|
# If you want to see the full commands, run:
|
|
# NOISY_BUILD=y make
|
|
#
|
|
ifeq ($(NOISY_BUILD),)
|
|
ECHO_PREFIX=@
|
|
CMD_PREFIX=@
|
|
PIPE_DEV_NULL=> /dev/null 2> /dev/null
|
|
else
|
|
ECHO_PREFIX=@\#
|
|
CMD_PREFIX=
|
|
PIPE_DEV_NULL=
|
|
endif
|
|
|
|
TAG=$(shell git rev-parse HEAD)
|
|
|
|
action-lint-file:
|
|
$(CMD_PREFIX) touch .action-lint
|
|
|
|
md-lint-file:
|
|
$(CMD_PREFIX) touch .markdown-lint
|
|
|
|
.PHONY: docling-serve-cpu-image
|
|
docling-serve-cpu-image: Containerfile ## Build docling-serve "cpu only" continaer image
|
|
$(ECHO_PREFIX) printf " %-12s Containerfile\n" "[docling-serve CPU ONLY]"
|
|
$(CMD_PREFIX) docker build --build-arg CPU_ONLY=true -f Containerfile --platform linux/amd64 -t ghcr.io/ds4sd/docling-serve-cpu:$(TAG) .
|
|
$(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve-cpu:$(TAG) ghcr.io/ds4sd/docling-serve-cpu:main
|
|
$(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve-cpu:$(TAG) quay.io/ds4sd/docling-serve-cpu:main
|
|
|
|
.PHONY: docling-serve-gpu-image
|
|
docling-serve-gpu-image: Containerfile ## Build docling-serve continaer image with GPU support
|
|
$(ECHO_PREFIX) printf " %-12s Containerfile\n" "[docling-serve with GPU]"
|
|
$(CMD_PREFIX) docker build --build-arg CPU_ONLY=false -f Containerfile --platform linux/amd64 -t ghcr.io/ds4sd/docling-serve:$(TAG) .
|
|
$(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve:$(TAG) ghcr.io/ds4sd/docling-serve:main
|
|
$(CMD_PREFIX) docker tag ghcr.io/ds4sd/docling-serve:$(TAG) quay.io/ds4sd/docling-serve:main
|
|
|
|
.PHONY: action-lint
|
|
action-lint: .action-lint ## Lint GitHub Action workflows
|
|
.action-lint: $(shell find .github -type f) | action-lint-file
|
|
$(ECHO_PREFIX) printf " %-12s .github/...\n" "[ACTION LINT]"
|
|
$(CMD_PREFIX) if ! which actionlint $(PIPE_DEV_NULL) ; then \
|
|
echo "Please install actionlint." ; \
|
|
echo "go install github.com/rhysd/actionlint/cmd/actionlint@latest" ; \
|
|
exit 1 ; \
|
|
fi
|
|
$(CMD_PREFIX) if ! which shellcheck $(PIPE_DEV_NULL) ; then \
|
|
echo "Please install shellcheck." ; \
|
|
echo "https://github.com/koalaman/shellcheck#user-content-installing" ; \
|
|
exit 1 ; \
|
|
fi
|
|
$(CMD_PREFIX) actionlint -color
|
|
$(CMD_PREFIX) touch $@
|
|
|
|
.PHONY: md-lint
|
|
md-lint: .md-lint ## Lint markdown files
|
|
.md-lint: $(wildcard */**/*.md) | md-lint-file
|
|
$(ECHO_PREFIX) printf " %-12s ./...\n" "[MD LINT]"
|
|
$(CMD_PREFIX) docker run --rm -v $$(pwd):/workdir davidanson/markdownlint-cli2:v0.14.0 "**/*.md"
|
|
$(CMD_PREFIX) touch $@
|
|
|
|
|
|
.PHONY: py-Lint
|
|
py-lint: ## Lint Python files
|
|
$(ECHO_PREFIX) printf " %-12s ./...\n" "[PY LINT]"
|
|
$(CMD_PREFIX) if ! which poetry $(PIPE_DEV_NULL) ; then \
|
|
echo "Please install poetry." ; \
|
|
echo "pip install poetry" ; \
|
|
exit 1 ; \
|
|
fi
|
|
$(CMD_PREFIX) poetry install --all-extras
|
|
$(CMD_PREFIX) poetry run pre-commit run --all-files
|