Skip to content

Document --error-on-warn option in README #599

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.

Sign up for GitHub

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

Open
denis-sokolov wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −0
Open

Document --error-on-warn option in README #599

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down