roave-backward-compatibility-check: add page (#3105)

2019-06-12 22:01:31 +01:00 · 2019-06-12 22:01:31 +01:00 · f6e4f3450d
parent fbf9b8bf3f
commit f6e4f3450d
1 changed files with 20 additions and 0 deletions
--- a/pages/common/roave-backward-compatibility-check.md
+++ b/pages/common/roave-backward-compatibility-check.md
@ -0,0 +1,20 @@
+# roave-backward-compatibility-check
+
+> A tool that can be used to verify backward compatibility breaks between two versions of a PHP library.
+> More information: <https://github.com/Roave/BackwardCompatibilityCheck>.
+
+- Check for breaking changes since the last tag:
+
+`roave-backward-compatibility-check`
+
+- Check for breaking changes since a specific tag:
+
+`roave-backward-compatibility-check --from={{git_reference}}`
+
+- Check for breaking changes between the last tag and a specific reference:
+
+`roave-backward-compatibility-check --to={{git_reference}}`
+
+- Check for breaking changes and output to markdown:
+
+`roave-backward-compatibility-check --format=markdown > {{results.md}}`