Or 1101 titond backend add swagger and ci for checking if the swagger doc is updated #10
Conversation
nguyenzung
requested review from
boohyung,
ohbyeongmin,
rlgns98kr and
AaronLee22
|
Will action be failed without swagger for each API now? |
That is exactly the way i am implementing. I compare the number of api in swagger docs and the total APIs - 1. |
Dockerfile
Outdated
| @@ -7,6 +7,7 @@ WORKDIR /app | |||
| COPY . . | |||
|
|
|||
| ARG TARGETOS TARGETARCH | |||
| RUN go install github.com/swaggo/swag@latest | |||
There was a problem hiding this comment.
I think we don't have to add this. we are not using swag command in docker container!
There was a problem hiding this comment.
Thank you!
In actual, i also was not sure about that!
There was a problem hiding this comment.
Thank you very much Brave! I think the command need to use swag command!
Instead of this, we have to add copy of api directory to /root/api!
@ohbyeongmin
And I'm sorry my missing about the directory of deployments. I gave fault path of it to you before. The path is /root/deployments!
There was a problem hiding this comment.
@nguyenzung
Oh, we are using the swag command in Dockerfile,,, I know it now. But we have to add files for swagger.
There was a problem hiding this comment.
FROM --platform=$BUILDPLATFORM golang:1.20-alpine AS builder
RUN apk add --no-cache make gcc musl-dev linux-headers git
WORKDIR /app
COPY . .
RUN go install github.com/swaggo/swag/cmd/swag@latest
ARG TARGETOS TARGETARCH
RUN GOOS=$TARGETOS GOARCH=$TARGETARCH make titond
FROM alpine
RUN apk add --no-cache ca-certificates jq curl
COPY --from=builder /app/api /root/api
COPY --from=builder /app/deployments /root/deployments
COPY --from=builder /app/build/bin/titond /usr/local/bin/
WORKDIR /root
ENTRYPOINT ["titond"]
There was a problem hiding this comment.
Thank you very much for your support
I updated and also update the base image due this issue: aws/aws-cli#4971
There was a problem hiding this comment.
Thank you!
But I think we don't have to get aws-cli in our container! If you agree, let me change it later!
There was a problem hiding this comment.
Yes, thank you,
I added aws-cli because I couldnot run in my laptop
nguyenzung
force-pushed
the
OR-1101-titond-backend-add-swagger-and-ci-for-checking-if-the-swagger-doc-is-updated
branch
from
c403cc5
to
4707570
Compare
cmd/titond/main.go
Outdated
| @@ -10,6 +10,7 @@ import ( | |||
| "github.com/tokamak-network/tokamak-titond-backend/pkg/http" | |||
| "github.com/tokamak-network/tokamak-titond-backend/pkg/kubernetes" | |||
| "github.com/tokamak-network/tokamak-titond-backend/pkg/services" | |||
| apptest "github.com/tokamak-network/tokamak-titond-backend/test" | |||
There was a problem hiding this comment.
I think we can use test as a package name now. It is small thing. Thank you! 😍
cmd/titond/main.go
Outdated
| @@ -107,6 +107,7 @@ func checkSwagger(ctx *cli.Context) error { | |||
| fmt.Printf("%-6s %-25s %s\n", route.Method, route.Path, route.Handler) | |||
| } | |||
| fmt.Println("Total APIs: ", numAPIs) | |||
| fmt.Println("Total APIs excluding swagger api: ", (numAPIs - 1)) | |||
| COPY --from=builder /app/deployments /root/deployments | ||
| COPY --from=builder /app/build/bin/titond /usr/local/bin/ | ||
|
|
||
| WORKDIR /usr/local/bin/ | ||
| WORKDIR /root |
There was a problem hiding this comment.
@ohbyeongmin We can use the ./deployments path in container env now!
Thank you!