83 lines
2.5 KiB
Makefile
83 lines
2.5 KiB
Makefile
# All documents to be used in spell check.
|
|
ALL_DOCS := $(shell find . -name '*.md' -not -path './.github/*' -type f | grep -v ^./node_modules | sort)
|
|
PWD := $(shell pwd)
|
|
|
|
TOOLS_DIR := ./internal/tools
|
|
MISSPELL_BINARY=bin/misspell
|
|
MISSPELL = $(TOOLS_DIR)/$(MISSPELL_BINARY)
|
|
MARKDOWN_LINK_CHECK=markdown-link-check
|
|
MARKDOWN_LINT=markdownlint
|
|
# see https://github.com/open-telemetry/build-tools/releases for semconvgen updates
|
|
SEMCONVGEN_VERSION=0.4.1
|
|
|
|
.PHONY: install-misspell
|
|
install-misspell:
|
|
# TODO: Check for existence before installing
|
|
cd $(TOOLS_DIR) && go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell
|
|
|
|
.PHONY: misspell
|
|
misspell:
|
|
$(MISSPELL) -error $(ALL_DOCS)
|
|
|
|
.PHONY: misspell-correction
|
|
misspell-correction:
|
|
$(MISSPELL) -w $(ALL_DOCS)
|
|
|
|
.PHONY: install-markdown-link-check
|
|
install-markdown-link-check:
|
|
# TODO: Check for existence before installing
|
|
npm install -g $(MARKDOWN_LINK_CHECK)
|
|
|
|
.PHONY: markdown-link-check
|
|
markdown-link-check:
|
|
@for f in $(ALL_DOCS); do $(MARKDOWN_LINK_CHECK) --quiet --config .markdown_link_check_config.json $$f; done
|
|
|
|
.PHONY: install-markdownlint
|
|
install-markdownlint:
|
|
# TODO: Check for existence before installing
|
|
npm install -g markdownlint-cli
|
|
|
|
.PHONY: markdownlint
|
|
markdownlint:
|
|
@for f in $(ALL_DOCS); do echo $$f; $(MARKDOWN_LINT) -c .markdownlint.yaml $$f || exit 1; done
|
|
|
|
.PHONY: install-yamllint
|
|
install-yamllint:
|
|
# Using a venv is recommended
|
|
pip install -U yamllint~=1.26.1
|
|
|
|
.PHONY: yamllint
|
|
yamllint:
|
|
yamllint .
|
|
|
|
# Generate markdown tables from YAML definitions
|
|
.PHONY: table-generation
|
|
table-generation:
|
|
docker run --rm -v $(PWD)/semantic_conventions:/source -v $(PWD)/specification:/spec \
|
|
otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec
|
|
|
|
# Check if current markdown tables differ from the ones that would be generated from YAML definitions
|
|
.PHONY: table-check
|
|
table-check:
|
|
docker run --rm -v $(PWD)/semantic_conventions:/source -v $(PWD)/specification:/spec \
|
|
otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec --md-check
|
|
|
|
.PHONY: schema-check
|
|
schema-check:
|
|
cd tools && ./schema_check.sh
|
|
|
|
# Run all checks in order of speed / likely failure.
|
|
.PHONY: check
|
|
check: misspell markdownlint markdown-link-check
|
|
@echo "All checks complete"
|
|
|
|
# Attempt to fix issues / regenerate tables.
|
|
.PHONY: fix
|
|
fix: table-generation misspell-correction
|
|
@echo "All autofixes complete"
|
|
|
|
# Attempt to install all the tools
|
|
.PHONY: install-tools
|
|
install-tools: install-misspell install-markdownlint install-markdown-link-check
|
|
@echo "All tools installed"
|