frostfs-api/Makefile

#!/usr/bin/make -f
SHELL=bash

include help.mk

.PHONY: doc fmt version compatibility pre-commit unpre-commit pre-commit-run

# Regenerate documentation for proto files:
doc:
	@for f in `find . -type f -name '*.proto' -exec dirname {} \; | sort -u `; do \
		echo "⇒ Documentation for $$(basename $$f)"; \
		protoc \
			--doc_opt=.github/markdown.tmpl,$${f}.md \
			--proto_path=.:/usr/local/include \
			--doc_out=proto-docs/ $${f}/*.proto; \
	done

# Run clang-format
fmt:
	@for f in `ls **/*.proto`; do \
		echo "⇒ Formatting $$f"; \
		clang-format -i $$f; \
	done

# Run version update check
version:
	@diff=$$(git diff-index master version.json); \
	if [[ -z "$$diff" ]]; then \
       echo "⇒ You need to update the api version in the version.json file"; \
       exit 1;\
    fi

# Run compatibility information check
compatibility:
	@version=$$(jq -r '.milestone' version.json).$$(jq -r '.patch' version.json); \
	conflicts=0; \
	for f in `ls **/*.json`; do \
		for rpc in $$(jq -r '.[] | to_entries | .[].key' $$f); do \
			if $$(jq -r '.[].'$$rpc' | has("v'$$version'") | not' $$f); then \
				echo "⇒ No compatibility information found for version" $$version "in file" $$f "for rpc" $$rpc; \
				conflicts=$$(($conflicts+1)); \
			fi \
  		done \
	done; \
	exit $$conflicts;

# Activate pre-commit hooks
pre-commit:
	pre-commit install --hook-type pre-commit

# Deactivate pre-commit hooks
unpre-commit:
	pre-commit uninstall --hook-type pre-commit

# Run pre-commit hooks
pre-commit-run:
	@pre-commit run --all-files --hook-stage manual