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

Add a brief page to the documentation showing how to use on CI #608

Closed
ptmkenny opened this issue Apr 29, 2024 · 2 comments
Closed

Add a brief page to the documentation showing how to use on CI #608

ptmkenny opened this issue Apr 29, 2024 · 2 comments
Labels
feature request Feature request

Comments

@ptmkenny
Copy link
Contributor

The project page mentions using knip on CI, but the documentation doesn't give any specific examples.

In my case, I was introducing knip into an existing project, so I needed to make use of --max-issues. I suggest adding a CI page highlighting --max-issues and --no-exit-code; since this is a headline feature of knip, it should be easy to find how to get started in the docs.

@ptmkenny ptmkenny added the feature request Feature request label Apr 29, 2024
@webpro
Copy link
Collaborator

webpro commented Apr 29, 2024

Thanks for raising this, I totally agree. Although these flags should not be featured as highlights, I think. Essentially they're hiding issues. Obviously in large projects issues can't be fixed at once when introducing Knip (or Knip itself reports false positives), so that's why the options do exist.

That said, this topic is mostly kind of tucked away in https://knip.dev/explanations/why-use-knip and at the very bottom of the CLI options pages. And no examples at all indeed.

There should be a "Using Knip in CI" page or similar, including examples and warnings :)

@webpro webpro closed this as completed in 2f75272 May 10, 2024
@webpro
Copy link
Collaborator

webpro commented May 10, 2024

🚀 This issue has been resolved in v5.14.0. See Release 5.14.0 for release notes.

Using Knip in a commercial project? Please consider sponsoring me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Feature request
Projects
None yet
Development

No branches or pull requests

2 participants