How with the 'backward-compatibility-check' command chech 2 files

[zanimonets]

The 'specmatic compare openapi1.yaml openapi2.yaml' works fine and marked as deprecated
But it's not clear how to do the same with 'backward-compatibility-check'
Attempts

1. specmatic backward-compatibility-check --target-path openapi1.yaml openapi2.yaml -> Unmatched argument at index (probably because it only supports one argument)
2. With specmatic.yaml

sources:
  - provider: filesystem
    provides:
      - openapi1.yaml

and specmatic backward-compatibility-check --target-path openapi2.yaml -> 1. Running the check for openapi2.yaml:
read(...) must not be null

[harikrishnan83]

@zanimonets Thanks for reaching out. We will get back to you shortly on this.

[samyakOO7]

Hey @zanimonets,

The new command backward-compatibility-check checks compatibility between different versions of your API specification files by comparing your local changes to the committed version in the repository.

For example:
To ensure backward compatibility using Specmatic, you can run the following command, assuming the openapi.yaml is already in your Git repository & the new changes made are local or in CI pipeline:

 specmatic backward-compatibility-check --target-path openapi.yaml

--target-path : Only used to limit the scope of check to particular file or directory while generally all the files are targeted.

For more details, check this Specmatic documentation for backward compatibility -
https://specmatic.io/documentation/backward_compatibility.html

compare is being deprecated. As Specmatic is a CDD framework so it's recommended to commit all your contract files to a git repository, hence backward-compatibility-check checks all the local changes against the git version

Hope this helps!
Please feel free to let us know in case of any doubts.