From 3761908aebce99e094a3de2c5e7f72236942ba29 Mon Sep 17 00:00:00 2001 From: Denis Sokolov Date: Mon, 30 Mar 2026 17:35:45 +0200 Subject: [PATCH] Document --error-on-warn option in README --error-on-warn option is not discoverable by new users, as it is not mentioned in README. Add it. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index c3a910b0..ff6a8e9f 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,20 @@ Run `patch-package` without arguments to apply all patches in your project. See https://github.com/ds300/patch-package/issues/86 for background. +- `--error-on-warn` + + Forces patch-package to exit with code 1 after warnings. + + The most common warning is likely a patch file version mismatch. If you + upgrade dependencies (semi-)automatically, you will run into seeing + the warning when installing. With the error-on-warn option you can ensure + that dependency upgrades are coupled with the patch version bump. + + `--error-on-warn` is not switched on by default on CI, + unlike error-on-fail. + + See https://github.com/ds300/patch-package/issues/345 for background. + - `--reverse` Un-applies all patches.