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.

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

feat: Enhanced Asset Change Detection in Shorebird #2840

Open
6 tasks
WafikSleim opened this issue Feb 3, 2025 · 1 comment
Open
6 tasks

feat: Enhanced Asset Change Detection in Shorebird #2840

WafikSleim opened this issue Feb 3, 2025 · 1 comment
Labels

Comments

@WafikSleim
Copy link

WafikSleim commented Feb 3, 2025

Description

When attempting to patch an iOS app using Shorebird, a warning appears indicating that asset changes will not be included in the patch:

[WARN] Your app contains asset changes, which will not be included in the patch.
    Changed files:
        Products/Applications/Runner.app/Assets.car

However, no detailed diff is provided for Assets.car, making it difficult to determine what has changed. This issue arises even when no intentional modifications have been made to icons or other assets, leading to unexpected warnings.


Requirements

  • Implement a method to generate a detailed diff for Assets.car using xcrun --sdk iphoneos assetutil --info Assets.car or a similar tool.
  • Include the diff output in the warning message when asset changes are detected.
  • Enable developers to easily identify what specific changes triggered the warning.
  • Update documentation to reflect this new feature, providing guidance on interpreting and resolving asset differences.
  • Display the Shorebird version used in the last release for better tracking and troubleshooting.
  • Allow developers to pull a specified Shorebird version to prevent compatibility issues.

Additional Context

  • This feature would significantly improve troubleshooting for developers facing unexpected asset change warnings while patching iOS apps.
  • The request stems from a real-world case where a minor update (modifying parameters in a URL launcher) triggered the warning, despite no intentional changes to assets.
  • Existing documentation mentions asset change warnings but does not provide a way to inspect the differences, making issue resolution more challenging.
@eseidel
Copy link
Contributor

eseidel commented Feb 3, 2025

Thanks for the report!

@eseidel eseidel added the ios label Feb 3, 2025
@eseidel eseidel added this to 1.1 Feb 3, 2025
@eseidel eseidel moved this to Backlog in 1.1 Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Backlog
Development

No branches or pull requests

2 participants