Skip to content

Commit

Permalink
docs: 📝 Add documentation on a breaking change for v5
Browse files Browse the repository at this point in the history
  • Loading branch information
MaximeRougieux committed Nov 14, 2023
1 parent bc68393 commit d6e16ca
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
## 0.5.0

**Breaking changes**

* Remove the semi colon in golden file names to support using the package on a Windows machine.

This is a breaking change for users who have generated golden files with the previous version of the library. The golden file names will now be `preview/${windowConfig.name}-${name.snakeCase}$localSuffix.png` instead of `preview/${windowConfig.name}:${name.snakeCase}$localSuffix.png`.

To resolve this, you can either rename the golden files manually or regenerate them.

## 0.4.1

* fix: Update broken link on README.md
Expand Down

0 comments on commit d6e16ca

Please sign in to comment.