-
Notifications
You must be signed in to change notification settings - Fork 482
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
📖 Clarifications about the pinned dependencies check #2319
📖 Clarifications about the pinned dependencies check #2319
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2319 +/- ##
=======================================
Coverage 40.55% 40.55%
=======================================
Files 112 112
Lines 8822 8822
=======================================
Hits 3578 3578
Misses 4984 4984
Partials 260 260 |
Integration tests success for |
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.
Generate the checks.md
file using make generate-docs
9e16d59
to
24fa891
Compare
Done (note I had to explicitly remove the file and then run the command... it didn't notice the change; makefile rule looks right to me though 🤷♂️ ) |
Integration tests success for |
Integration tests success for |
The pinned dependencies check is confusing to authors of libraries, who shouldn't be pinning the dependencies of the library. But it is still valuable for flagging things which are used as part of the build and release process for a library. Signed-off-by: Jeremy Katz <jeremy@tidelift.com>
Signed-off-by: Jeremy Katz <jeremy@tidelift.com>
24fa891
to
0ffb19a
Compare
Integration tests success for |
* Clarifications about the pinned dependencies check The pinned dependencies check is confusing to authors of libraries, who shouldn't be pinning the dependencies of the library. But it is still valuable for flagging things which are used as part of the build and release process for a library. Signed-off-by: Jeremy Katz <jeremy@tidelift.com> * Regenerate docs/checks.md Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: latortuga <latortugaaaa>
* Clarifications about the pinned dependencies check The pinned dependencies check is confusing to authors of libraries, who shouldn't be pinning the dependencies of the library. But it is still valuable for flagging things which are used as part of the build and release process for a library. Signed-off-by: Jeremy Katz <jeremy@tidelift.com> * Regenerate docs/checks.md Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: nathaniel.wert <nathaniel.wert@kudelskisecurity.com>
* Clarifications about the pinned dependencies check The pinned dependencies check is confusing to authors of libraries, who shouldn't be pinning the dependencies of the library. But it is still valuable for flagging things which are used as part of the build and release process for a library. Signed-off-by: Jeremy Katz <jeremy@tidelift.com> * Regenerate docs/checks.md Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: nathaniel.wert <nathaniel.wert@kudelskisecurity.com>
* Clarifications about the pinned dependencies check The pinned dependencies check is confusing to authors of libraries, who shouldn't be pinning the dependencies of the library. But it is still valuable for flagging things which are used as part of the build and release process for a library. Signed-off-by: Jeremy Katz <jeremy@tidelift.com> * Regenerate docs/checks.md Signed-off-by: Jeremy Katz <jeremy@tidelift.com> Signed-off-by: Jeremy Katz <jeremy@tidelift.com>
The pinned dependencies check is confusing to authors of libraries, who shouldn't be pinning the dependencies of the library. But it is still valuable for flagging things which are used as part of the build and release process for a library.
Signed-off-by: Jeremy Katz jeremy@tidelift.com
What kind of change does this PR introduce?
Docs update
What is the current behavior?
Currently library maintainers are confused thinking that this check wants them to pin their dependencies but that is not the real intent. This tries to make the documentation a little clearer.
Which issue(s) this PR fixes
NONE
Special notes for your reviewer
Does this PR introduce a user-facing change?