feat: adding better logging on iOS build command when generate shorebird file is not found.

[erickzanardo]

A few issues are reporting a similar error:

Exception: Cannot find shorebird.yaml

• Renaming Runner to a name containing a . causes shorebird release ios to fail shorebird#2206
• Failed to build: [shorebird] failed to generate shorebird configuration. shorebird#1914
• [shorebird] failed to generate shorebird configuration. shorebird#2212
• [shorebird] failed to generate shorebird configuration. shorebird#2131

That log doesn't tell us much though. This PR doesn't solve that issue, but adds better logging when this is happens so we can try troubleshoot this better.

[eseidel]

lgtm, do we need a test?

[erickzanardo]

lgtm, do we need a test?

I would love to add a test for this, but unfortunately I still am not able to reproduce the issue. I am hopping that with this log, we might be able to get better information.

[eseidel]

Why have the max depth at all?

[erickzanardo]

I might be too overcautious here, but I was worried that we end up recurring back too much and end in a user "personal" folder and kind trigger the user that we are invading their files.

This depth makes sure that we don't go past the build folder.

[eseidel]

Comment should probably say that then. :)

[erickzanardo]

Example of output:

[   +1 ms] [shorebird] failed to generate shorebird configuration.
           Exception: Cannot find shorebird.yaml in /Users/erick/projects/shorebird/supports/gh_2212/dashes-are-fun/build/ios/archive/Super.xcarchive/Products/Applications/Super.Pato.app/Frameworks/App.framework/flutter_assets/shorebird.yaml.
           Resolved app name: Super.Pato.app

           Closest existing parent:
             PATH: /Users/erick/projects/shorebird/supports/gh_2212/dashes-are-fun/build/ios/archive
             CHILDREN: Super.Pato.xcarchive

           Please file an issue at: https://github.com/shorebirdtech/shorebird/issues/new
           ```