-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gin swagger; remove streamlit #442
Conversation
@@ -53,6 +52,12 @@ func run() error { | |||
logrus.Fatalf("could not instantiate config: %s", err.Error()) | |||
} | |||
|
|||
// set up some additional swagger config | |||
doc.SwaggerInfo.Version = cfg.SVN |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
adding the docs.go
file is necessary to do this config
Codecov Report
@@ Coverage Diff @@
## main #442 +/- ##
=======================================
Coverage 21.39% 21.39%
=======================================
Files 48 49 +1
Lines 5366 5370 +4
=======================================
+ Hits 1148 1149 +1
- Misses 4034 4037 +3
Partials 184 184
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor nit to make this more robust.
.github/workflows/ci.yml
Outdated
- name: Update spec and push generated spec file | ||
if: github.event_name == 'pull_request' && github.event.action != 'closed' && github.event.pull_request.merged != true | ||
run: | | ||
mage spec |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mage spec
is also doing formatting of files. See
Lines 114 to 117 in 7047be5
if err := sh.Run(swagCommand, "fmt", "-d", "pkg/server/router"); err != nil { | |
logrus.Fatal(err) | |
return err | |
} |
I think that needs to be broken up into separate mage targets.
As it stands, you might get a passing CI during branch review, but failing in main because of this (a linter might fail).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
* origin/main: gin swagger; remove streamlit (#442) # Conflicts: # pkg/server/framework/server.go # pkg/server/router/did.go # pkg/server/router/health.go # pkg/server/router/readiness.go # pkg/server/server.go
fixes #438
Cannot merge this until we figure out how to get a build user to push to main with updated swagger docs. See: https://github.com/orgs/community/discussions/25305