-
Notifications
You must be signed in to change notification settings - Fork 33
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
feat: Update postProcess
config to allow alternate save mechanism
#91
Conversation
A new `saveSwagger()` configuration function allows an alternate mechanism for saving the generated Swagger to be specified, rather than the standard writing a file to the filesystem.
Improve README documentation.
Improve README documentation.
just fixed the Travis CI bug: https://travis-ci.community/t/github-pr-is-being-built-but-result-is-not-shown/7025/2 restarted the build to see if it will show up here |
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.
👍
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.
since no big difference between this and postProcess
method, what about we lean towards encouraging the use of that and keep the ignore saving to local storage when swaggerJsonPath
is not truthy
Let’s go that way. I could not make up my mind given the small amount of post-processing (tag clean-up) that currently happens after I had originally left tag cleanup after |
Update `postProcess` configuration to run after tag clean-up phase to allow an alternate mechanism for saving the generated Swagger to be specified, rather than the standard writing a file to the filesystem. Allow `swaggerJsonPath` to be empty/null/undefined, in which case no file write attempted.
Correct interface.
saveSwagger
config allows an alternate mechanism for savingpostProcess
config to allow alternate save mechanism
🎉 This PR is included in version 3.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
A newsaveSwagger()
configuration function allows an alternatemechanism for saving the generated Swagger to be specified, rather
than the standard writing a file to the filesystem.
Update
postProcess
configuration to run after tag clean-up phaseto allow an alternate mechanism for saving the generated Swagger to
be specified, rather than the standard writing a file to the filesystem.
Allow
swaggerJsonPath
to be empty/null/undefined, in which caseno file write attempted.
This supports deployment to environments that do not allow writing to the
filesystem e.g. store in memory or database.