Add mention to the sample in Compose Preview Support document #448
+2
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-merge-queue bot
pushed a commit
to slackhq/circuit
that referenced
this pull request
Jul 29, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [io.github.takahirom.roborazzi](https://github.com/takahirom/roborazzi) | plugin | minor | `1.23.0` -> `1.24.0` | | [io.github.takahirom.roborazzi:roborazzi-junit-rule](https://github.com/takahirom/roborazzi) | dependencies | minor | `1.23.0` -> `1.24.0` | | [io.github.takahirom.roborazzi:roborazzi-compose](https://github.com/takahirom/roborazzi) | dependencies | minor | `1.23.0` -> `1.24.0` | | [io.github.takahirom.roborazzi:roborazzi](https://github.com/takahirom/roborazzi) | dependencies | minor | `1.23.0` -> `1.24.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>takahirom/roborazzi (io.github.takahirom.roborazzi)</summary> ### [`v1.24.0`](https://github.com/takahirom/roborazzi/releases/tag/1.24.0) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.23.0...1.24.0) ##### New feature: Support for includePrivatePreviews in Compose Preview Support Compose Preview Support, initially released in version 1.22.0, now includes the `includePrivatePreviews` option. This feature allows you to include private previews in your Compose Preview Support setup. You can enable this by setting `includePrivatePreviews` in `roborazzi.generateComposePreviewRobolectricTests.includePrivatePreviews`. Thank you for submitting this feature request, [@​yuchan2215](https://github.com/yuchan2215) ! ##### New feature: JUnit rule support in ComposePreviewTester We've enhanced ComposePreviewTester to support JUnit rules. Previously, ComposePreviewTester lacked lifecycle hooks, which made certain scenarios challenging to handle. Now, you can pass your own Test rules, including your Compose Test Rule, and use them in tests. For a sample implementation, check out [this integration test](https://github.com/takahirom/roborazzi/blob/2519f46ec0e5a8dadc5139ae833e2925c90c8b21/include-build/roborazzi-gradle-plugin/src/integrationTest/projects/sample-generate-preview-tests/src/test/java/com/github/takahirom/sample/CustomPreviewTester.kt). ##### Breaking changes for users of the `ComposePreviewTester` interface As we continue to improve Compose Preview Support, we've made some changes to the `ComposePreviewTester` interface. These changes introduce a breaking change for current users. ComposePreviewTester is an interface for modifying the behavior of Compose Preview Support. Previously, the API was prone to breaking changes with each new option added. We've addressed this issue by introducing a new `options()` function. However, this necessitates a change in how you use the interface. Old interface: ```kotlin fun previews(vararg packages: String): List<ComposablePreview<T>> ``` New interface (Packages can now be accessed via `options().scanOptions.packages`): ```kotlin fun previews(): List<ComposablePreview<T>> ``` ##### Acknowledgments We'd like to extend our sincere thanks to [@​yschimke](https://github.com/yschimke) and [@​sergio-sastre](https://github.com/sergio-sastre) for their valuable design reviews and insightful feedback, which greatly contributed to the improvements in this release. ##### What's Changed - \[Idea Plugin] Improve performance of idea plugin by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#439 - \[Idea Plugin] Prepare for release of IntelliJ IDEA plugin by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#442 - \[Idea Plugin] Tweak idea plugin UI by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#443 - \[Feature, Breaking Changes] Support includePrivatePreviews of ComposablePreviewScanner by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#445 - \[Docs] Add mention to the sample in Compose Preview Support document by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#448 - \[Docs] Fix URL of the README link by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#449 **Full Changelog**: takahirom/roborazzi@1.23.0...1.24.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44LjMiLCJ1cGRhdGVkSW5WZXIiOiIzOC44LjMiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbXX0=-->
chrisbanes
pushed a commit
to chrisbanes/haze
that referenced
this pull request
Aug 1, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [io.github.takahirom.roborazzi](https://github.com/takahirom/roborazzi) | `1.23.0` -> `1.25.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi-junit-rule](https://github.com/takahirom/roborazzi) | `1.23.0` -> `1.25.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi-compose-desktop](https://github.com/takahirom/roborazzi) | `1.23.0` -> `1.25.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi-compose](https://github.com/takahirom/roborazzi) | `1.23.0` -> `1.25.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [io.github.takahirom.roborazzi:roborazzi](https://github.com/takahirom/roborazzi) | `1.23.0` -> `1.25.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>takahirom/roborazzi (io.github.takahirom.roborazzi)</summary> ### [`v1.25.0`](https://github.com/takahirom/roborazzi/releases/tag/1.25.0) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.24.0...1.25.0) ##### New Experimental Gradle Task: `clear` The Roborazzi Gradle Plugin saves image caches in `build/intermediates/roborazzi`. When users remove images in `build/outputs/roborazzi` and rerun the tests, it doesn't work as expected. To address this, we've added a Gradle task `clearRoborazziDebug` to remove all images. I'm gathering feedback about this task in [#​452](https://github.com/takahirom/roborazzi/issues/452). Please let me know if this causes any issues in your workflow. I'm aware that there are many different ways to use Roborazzi, and I'd like to improve your project workflow. ##### What's Changed - \[IDE Plugin] Hide dropdown border if no gradle tasks exists by [@​eyedol](https://github.com/eyedol) in [takahirom/roborazzi#451 Thank you for your contribution! - \[Feature] Add clear roborazzi task by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#453 **Full Changelog**: takahirom/roborazzi@1.24.0...1.25.0 ### [`v1.24.0`](https://github.com/takahirom/roborazzi/releases/tag/1.24.0) [Compare Source](https://github.com/takahirom/roborazzi/compare/1.23.0...1.24.0) ##### New feature: Support for includePrivatePreviews in Compose Preview Support Compose Preview Support, initially released in version 1.22.0, now includes the `includePrivatePreviews` option. This feature allows you to include private previews in your Compose Preview Support setup. You can enable this by setting `includePrivatePreviews` in `roborazzi.generateComposePreviewRobolectricTests.includePrivatePreviews`. Thank you for submitting this feature request, [@​yuchan2215](https://github.com/yuchan2215) ! ##### New feature: JUnit rule support in ComposePreviewTester We've enhanced ComposePreviewTester to support JUnit rules. Previously, ComposePreviewTester lacked lifecycle hooks, which made certain scenarios challenging to handle. Now, you can pass your own Test rules, including your Compose Test Rule, and use them in tests. For a sample implementation, check out [this integration test](https://github.com/takahirom/roborazzi/blob/2519f46ec0e5a8dadc5139ae833e2925c90c8b21/include-build/roborazzi-gradle-plugin/src/integrationTest/projects/sample-generate-preview-tests/src/test/java/com/github/takahirom/sample/CustomPreviewTester.kt). ##### Breaking changes for users of the `ComposePreviewTester` interface As we continue to improve Compose Preview Support, we've made some changes to the `ComposePreviewTester` interface. These changes introduce a breaking change for current users. ComposePreviewTester is an interface for modifying the behavior of Compose Preview Support. Previously, the API was prone to breaking changes with each new option added. We've addressed this issue by introducing a new `options()` function. However, this necessitates a change in how you use the interface. Old interface: ```kotlin fun previews(vararg packages: String): List<ComposablePreview<T>> ``` New interface (Packages can now be accessed via `options().scanOptions.packages`): ```kotlin fun previews(): List<ComposablePreview<T>> ``` ##### Acknowledgments We'd like to extend our sincere thanks to [@​yschimke](https://github.com/yschimke) and [@​sergio-sastre](https://github.com/sergio-sastre) for their valuable design reviews and insightful feedback, which greatly contributed to the improvements in this release. ##### What's Changed - \[Idea Plugin] Improve performance of idea plugin by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#439 - \[Idea Plugin] Prepare for release of IntelliJ IDEA plugin by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#442 - \[Idea Plugin] Tweak idea plugin UI by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#443 - \[Feature, Breaking Changes] Support includePrivatePreviews of ComposablePreviewScanner by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#445 - \[Docs] Add mention to the sample in Compose Preview Support document by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#448 - \[Docs] Fix URL of the README link by [@​takahirom](https://github.com/takahirom) in [takahirom/roborazzi#449 **Full Changelog**: takahirom/roborazzi@1.23.0...1.24.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/chrisbanes/haze). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzguMCIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.