improve API docs linter (#3608)

This commit is contained in:
Alessandro Ros
2024-08-04 13:12:30 +02:00
committed by GitHub
parent 49c8acf2f6
commit 972ffbf332
21 changed files with 182 additions and 25 deletions
+1 -12
View File
@@ -1,21 +1,10 @@
define DOCKERFILE_APIDOCS_LINT
FROM $(NODE_IMAGE)
RUN yarn global add @redocly/cli@1.0.0-beta.123
endef
export DOCKERFILE_APIDOCS_LINT
apidocs-lint:
echo "$$DOCKERFILE_APIDOCS_LINT" | docker build . -f - -t temp
docker run --rm -v $(PWD)/apidocs:/s -w /s temp \
sh -c "openapi lint openapi.yaml"
define DOCKERFILE_APIDOCS_GEN
FROM $(NODE_IMAGE)
RUN yarn global add redoc-cli@0.13.7
endef
export DOCKERFILE_APIDOCS_GEN
apidocs-gen:
apidocs:
echo "$$DOCKERFILE_APIDOCS_GEN" | docker build . -f - -t temp
docker run --rm -v $(PWD)/apidocs:/s -w /s temp \
sh -c "redoc-cli bundle openapi.yaml"
+18 -1
View File
@@ -1,5 +1,22 @@
lint:
define DOCKERFILE_APIDOCS_LINT
FROM $(NODE_IMAGE)
RUN yarn global add @redocly/cli@1.0.0-beta.123
endef
export DOCKERFILE_APIDOCS_LINT
lint-golangci:
touch internal/servers/hls/hls.min.js
docker run --rm -v $(PWD):/app -w /app \
$(LINT_IMAGE) \
golangci-lint run -v
lint-mod-tidy:
go mod tidy
git diff --exit-code
lint-apidocs:
echo "$$DOCKERFILE_APIDOCS_LINT" | docker build . -f - -t temp
docker run --rm -v $(PWD)/apidocs:/s -w /s temp \
sh -c "openapi lint openapi.yaml"
lint: lint-golangci lint-mod-tidy lint-apidocs
+1 -1
View File
@@ -1,6 +1,6 @@
test-highlevel-nodocker:
go generate ./...
go test -v -race -tags enable_highlevel_tests ./internal/highleveltests
go test -v -race -tags enable_highlevel_tests ./internal/testhighlevel
define DOCKERFILE_HIGHLEVEL_TEST
FROM $(BASE_IMAGE)