From f6e4f3450dcb5763c73182971d0850e8c120b925 Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Wed, 12 Jun 2019 22:01:31 +0100 Subject: [PATCH] roave-backward-compatibility-check: add page (#3105) --- .../roave-backward-compatibility-check.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 pages/common/roave-backward-compatibility-check.md diff --git a/pages/common/roave-backward-compatibility-check.md b/pages/common/roave-backward-compatibility-check.md new file mode 100644 index 000000000..f9de31707 --- /dev/null +++ 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: . + +- 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}}`