mirror of
https://github.com/moby/moby.git
synced 2026-01-11 18:51:37 +00:00
0666108ebf
Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> revert api/swagger.yaml to undo formatting Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> refactor(api): update Dockerfile and Makefile with newline at the EOF and use current best practices Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> refactor validations and swagger generation flow Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> shfmt Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com> Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> refactor generate-swagger-api.sh to use absolute path Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> add validate-api-swagger job for GitHub Actions Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> fix validate-api-swagger ci workflow Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> update go version and redoc in api module Signed-off-by: Rafael Camelo <rafaelcamelo31@gmail.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
65 lines
1.8 KiB
Makefile
65 lines
1.8 KiB
Makefile
# API Module Makefile
|
|
# This Makefile provides targets for the swagger generation and validation
|
|
# which are specific to the API module.
|
|
|
|
DOCKER ?= docker
|
|
BUILDX ?= $(DOCKER) buildx
|
|
|
|
API_DIR := $(CURDIR)
|
|
PROJECT_PATH := /go/src/github.com/moby/moby
|
|
|
|
DOCKER_MOUNT := -v "$(API_DIR):$(PROJECT_PATH)/api"
|
|
|
|
DOCKER_IMAGE := docker-api-dev
|
|
|
|
DOCKER_WORKDIR := -w $(PROJECT_PATH)/api
|
|
|
|
DOCKER_FLAGS := $(DOCKER) run --rm $(DOCKER_MOUNT) $(DOCKER_WORKDIR)
|
|
DOCKER_RUN := $(DOCKER_FLAGS) "$(DOCKER_IMAGE)"
|
|
|
|
DOCKER_CONTAINER_NAME := $(if $(CONTAINER_NAME),--name $(CONTAINER_NAME),)
|
|
|
|
BUILD_CMD := $(BUILDX) build
|
|
GO_VERSION ?= 1.25.4
|
|
SWAGGER_VERSION ?= v0.33.1
|
|
SWAGGER_DOCS_PORT ?= 9000
|
|
|
|
.DEFAULT_GOAL := help
|
|
|
|
.PHONY: build
|
|
build:
|
|
$(BUILD_CMD) \
|
|
--build-arg GO_VERSION=$(GO_VERSION) \
|
|
--build-arg SWAGGER_VERSION=$(SWAGGER_VERSION) \
|
|
--target dev \
|
|
--load \
|
|
-t "$(DOCKER_IMAGE)" \
|
|
-f Dockerfile \
|
|
.
|
|
|
|
.PHONY: swagger-gen
|
|
swagger-gen: build ## generate swagger API types
|
|
$(DOCKER_RUN) ./scripts/generate-swagger-api.sh
|
|
|
|
.PHONY: swagger-docs
|
|
swagger-docs: ## preview the API documentation
|
|
@echo "API docs preview will be running at http://localhost:$(SWAGGER_DOCS_PORT)"
|
|
@docker run --rm \
|
|
-v $(PWD)/:/usr/share/nginx/html/swagger/ \
|
|
-e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering' \
|
|
-e SPEC_URL="swagger/swagger.yaml" \
|
|
-p $(SWAGGER_DOCS_PORT):80 \
|
|
redocly/redoc:v2.5.1
|
|
|
|
.PHONY: validate-swagger
|
|
validate-swagger: build ## validate the swagger.yaml file
|
|
$(DOCKER_RUN) ./scripts/validate-swagger.sh
|
|
|
|
.PHONY: validate-swagger-gen
|
|
validate-swagger-gen: build ## validate generated types are up-to-date
|
|
$(DOCKER_RUN) ./scripts/validate-swagger-gen.sh
|
|
|
|
.PHONY: help
|
|
help: ## display this help message
|
|
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
|