Skip to content
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

Add link to Smithy Diff from Evolving Models guide #1208

Merged
merged 1 commit into from
Apr 26, 2022
Merged

Add link to Smithy Diff from Evolving Models guide #1208

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
8 changes: 8 additions & 0 deletions docs/source/1.0/guides/evolving-models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,11 @@ The following changes to trait definitions are backward compatible:
#. Removing a trait from the ``conflicts`` list.
#. Removing the ``structurallyExclusive`` property.
#. Marking a trait as deprecated.


Using Smithy Diff
=================

`Smithy Diff <https://github.com/awslabs/smithy/tree/main/smithy-diff>`_ is a
tool used to compare two Smithy models to check for backward compatibility
issues. Smithy Diff can be run via a Java library or via the Smithy CLI.