# Floci repo tasks. # # Action-table docs: docs/services/*.md "Supported Actions" tables are generated # from handler source. See tools/docs/. # # Service-matrix docs: docs/services/index.md's Service Matrix table is checked # against ResolvedServiceCatalog.java so a registered service can't ship undocumented. PYTHON ?= python3 .PHONY: docs-sync docs-check docs-test docs-sync: ## Regenerate the action tables in docs/services from handler source (in place) $(PYTHON) tools/docs/regen_action_docs.py $(PYTHON) tools/docs/regen_cfn_resource_types.py docs-check: ## CI gate: regenerate and fail if anything is stale, unregistered, or undocumented @$(PYTHON) tools/docs/regen_action_docs.py --strict || { \ echo ""; \ echo "error: action-table regeneration reported problems (see warnings above)."; \ exit 1; \ } @$(PYTHON) tools/docs/regen_cfn_resource_types.py --strict || { \ echo ""; \ echo "error: the CloudFormation resource-type table is stale or reported problems."; \ echo " Run 'make docs-sync' and commit the result."; \ exit 1; \ } @git diff --exit-code -- docs/ || { \ echo ""; \ echo "error: docs/services action tables are out of date."; \ echo " Run 'make docs-sync' and commit the result."; \ exit 1; \ } @$(PYTHON) tools/docs/check_service_matrix.py --strict || { \ echo ""; \ echo "error: the Service Matrix in docs/services/index.md is out of sync (see warnings above)."; \ exit 1; \ } @! grep -rn -- '-jvm' docs README.md CONTRIBUTING.md || { \ echo ""; \ echo "error: docs name a '-jvm' image tag; release.yml publishes only x.y.z, latest and their -compat twins."; \ exit 1; \ } docs-test: ## Run the docs tooling's unit tests $(PYTHON) -m pytest tools/docs -q