Skip to content

Commit

Permalink
Added a heading to the line on example validation
Browse files Browse the repository at this point in the history
  • Loading branch information
joelrosario committed Aug 5, 2024
1 parent f4f52a5 commit 3ea214b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/central_contract_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ It is a good idea to prevent any direct commits to your master / main branch of
* **Github Action** - Please see this [Github Workflow file](https://github.com/znsio/specmatic-order-contracts/blob/main/.github/workflows/pull_request_merge_checks.yaml) where we are running the `specmatic backwardCompatibilityCheck` on the central repo. This command does two levels of checks.
* Any files that have changed in the Pull Request branch and compares them against their respective version in default branch (which is target of the PR)
* Also any files which refer to the change set are also tested for breaking changes (this is necessary to cover the scenario where common schema has been extracted to a separate file and changes to this file impacts backward compatibility of other files that refer to it)
* The `specmatic backwardCompatibilityCheck` fails when backward-incompatible changes are detected, and when named examples are out of line with their schema.
* **Example Validation** - The `specmatic backwardCompatibilityCheck` fails when backward-incompatible changes are detected, and when named examples are out of line with their schema.
* Specmatic returns a 0 or 1 just like any command line tool for success and error respectively based on which we can fail the build. At this point the team can decide if they should version bump the specification or change the code such that it is backward compatible

#### Sample Central Contract Repository with Pre-merge checks
Expand Down

0 comments on commit 3ea214b

Please sign in to comment.