Skip to content
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

I would like to be able to pass a flag to the cli tool to fail if errors are found #370

Open
vidhill opened this issue Jul 14, 2023 · 1 comment
Labels
pinned Issues that will not be automatically closed

Comments

@vidhill
Copy link

vidhill commented Jul 14, 2023

Is your feature request related to a problem? Please describe.

We are using the swagger-jsdoc cli in an npm script

e.g.

npx swagger-jsdoc -d definition.js -o api-docs.json index.js

If the scan fails the process exits with a code 0 which indicates success

When running on CICD I would like the job to fail so the process would need to exit with non-zero code
Describe the solution you'd like

Add a cli flag (suggestion --bail), when the flag is set exit with non-zero code if scanning fails

Describe alternatives you've considered
I could use the programmatic api, but I think this could be a useful feature

@stale
Copy link

stale bot commented Sep 13, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Sep 13, 2023
@daniloab daniloab added the pinned Issues that will not be automatically closed label Sep 13, 2023
@stale stale bot removed the wontfix label Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pinned Issues that will not be automatically closed
Projects
None yet
Development

No branches or pull requests

2 participants