Skip to content

Commit

Permalink
(chore/build) add api-doc make target
Browse files Browse the repository at this point in the history
  • Loading branch information
leonjza committed Oct 10, 2024
1 parent 5b11e4c commit c0a577c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PLATFORMS := darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 linux/arm windows
CGO := CGO_ENABLED=0

# Default target
default: clean test frontend build integrity
default: clean test frontend api-doc build integrity

# Clean up build artifacts
clean:
Expand All @@ -29,6 +29,11 @@ frontend: check-npm
check-npm:
@command -v npm >/dev/null 2>&1 || { echo >&2 "npm is not installed. Please install npm first."; exit 1; }

# Generate a swagger.json used for the api documentation
api-doc:
~/go/bin/swag i --exclude ./web/ui --output web/docs
~/go/bin/swag f

# Run any tests
test:
@echo "Running tests..."
Expand Down

0 comments on commit c0a577c

Please # to comment.