[spaceship][deliver][pilot] Add support for App Clips default experience metadata and review information by Krych · Pull Request #30010 · fastlane/fastlane

Krych · 2026-04-30T12:53:56Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I see several green ci/circleci builds in the "All checks have passed" section of my PR
I've read the Contribution Guidelines (https://github.com/fastlane/fastlane/blob/master/CONTRIBUTING.md)
I've updated the documentation if necessary.
I've added or updated relevant unit tests.

Motivation and Context

This PR is a rebase of #29738 (by @daniel-l2) onto the current master. The original PR has been stalled due to merge conflicts since November 2025. @iBotPeaches expressed interest in reviewing it once it was brought up to date — this PR
does exactly that.

The full history of this feature goes back to #19043 → #20300 → #21180 → #22041 → #29738 → this PR.

Our team ships an app with an App Clip and relies on these features in production (as does @bassrock's team per this comment (#29738 (comment))).

Description

All credit for the implementation goes to the original contributors of #29738 and #22041. This PR only resolves rebase conflicts against current master — no logic changes were made.

What's included:

Deliver — App Clip metadata support

app_clip_default_experience_action option (PLAY, VIEW, OPEN, etc.)
app_clip_default_experience_subtitle — localized hash
app_clip_header_images_path — localized header images (1800x1200 enforced)
app_clip_review_information — App Clip review details
deliver download_app_clip_header_images command
Automatic metadata copy from live version when no options specified

Pilot — Beta testing support

beta_app_clip_invocations option

Spaceship — API layer

New models: AppClip, AppClipDefaultExperience, AppClipDefaultExperienceLocalization, AppClipHeaderImage, AppClipAppStoreReviewDetail
New endpoints in tunes.rb and connect_api.rb

Default folder support

Place a single header image in default/ to apply it to all languages
Override per-language by adding a language-specific folder

Example usage:

 deliver(
   app_clip_default_experience_action: "PLAY",
   app_clip_default_experience_subtitle: {
     "en-US" => "Quick access to our app",
     "ko" => "앱에 빠르게 접근"
   },
   app_clip_header_images_path: "./fastlane/app-clip-header-images"
 )

Testing Steps

Create an app with an App Clip target
Set up folder structure: fastlane/app-clip-header-images/default/header.jpg # 1800x1200
Run fastlane deliver
Verify in App Store Connect that all enabled languages have the header image and subtitle

iBotPeaches · 2026-05-01T10:19:50Z

thanks. Adding Copilot to take a look.

Copilot

Pull request overview

Adds App Clip support across spaceship (ASC API layer), deliver (App Clip default experience metadata, header images, review info + download command), and pilot (TestFlight beta App Clip invocations), rebased onto current master.

Changes:

Spaceship: add App Clip and Beta App Clip Invocation endpoints + new ConnectAPI models.
Deliver: add upload/download support for App Clip default experience metadata, header images, and App Clip review information (including “default/” folder fallback behavior).
Pilot: add options and implementation to create/update/delete beta App Clip invocations on a build.

Reviewed changes

Copilot reviewed 27 out of 29 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
spaceship/lib/spaceship/connect_api/tunes/tunes.rb	Adds Tunes API endpoints for App Clip default experience, header images, review details, and beta invocations.
spaceship/lib/spaceship/connect_api/models/build_bundle.rb	Adds `APP_CLIP` bundle type constant.
spaceship/lib/spaceship/connect_api/models/beta_app_clip_invocation.rb	New model for beta App Clip invocations.
spaceship/lib/spaceship/connect_api/models/beta_app_clip_invocation_localization.rb	New model for beta App Clip invocation localizations.
spaceship/lib/spaceship/connect_api/models/app_store_version.rb	Adds mapping/accessor for `app_clip_default_experience`.
spaceship/lib/spaceship/connect_api/models/app_clip_header_image.rb	New model + upload logic for App Clip header images.
spaceship/lib/spaceship/connect_api/models/app_clip_default_experience_localization.rb	New model for App Clip default experience localizations.
spaceship/lib/spaceship/connect_api/models/app_clip_default_experience.rb	New model for the default App Clip experience.
spaceship/lib/spaceship/connect_api/models/app_clip_app_store_review_detail.rb	New model for App Clip review details (invocation URLs).
spaceship/lib/spaceship/connect_api/models/app_clip.rb	New model for App Clip resource.
spaceship/lib/spaceship/connect_api/models/app.rb	Adds App Clip relationship mapping + `get_app_clips`.
spaceship/lib/spaceship/connect_api.rb	Wires new App Clip / beta invocation models into ConnectAPI requires.
pilot/lib/pilot/options.rb	Adds `app_clip_invocations` and `overwrite_app_clip_invocations` options.
pilot/lib/pilot/build_manager.rb	Implements creation/update/deletion of beta App Clip invocations/localizations.
fastlane/lib/fastlane/actions/docs/upload_to_app_store.md.erb	Documents Deliver App Clip options, folder structure, and review info.
deliver/spec/upload_app_clip_default_experience_header_images_spec.rb	Adds unit tests for default-folder header image assignment logic.
deliver/spec/loader_spec.rb	Adds loader specs for App Clip header images + default folder behavior.
deliver/lib/deliver/upload_metadata.rb	Adds App Clip review info support + includes default experience when fetching versions.
deliver/lib/deliver/upload_app_clip_default_experience_metadata.rb	New uploader for App Clip default experience metadata (incl. live-copy behavior).
deliver/lib/deliver/upload_app_clip_default_experience_header_images.rb	New uploader for App Clip header images (incl. default folder behavior).
deliver/lib/deliver/runner.rb	Ensures App Clip default experience + header images upload runs before main metadata upload.
deliver/lib/deliver/options.rb	Adds Deliver config items for App Clip metadata/images/review info/action/subtitle.
deliver/lib/deliver/loader.rb	Adds filesystem loader + validation for App Clip header images.
deliver/lib/deliver/languages.rb	Adds shared language detection helper used by new App Clip flows.
deliver/lib/deliver/download_app_clip_header_images.rb	New command implementation to download existing App Clip header images.
deliver/lib/deliver/commands_generator.rb	Adds `deliver download_app_clip_header_images` command.
deliver/lib/deliver/app_clip_header_image.rb	New Deliver-side value object for a localized App Clip header image.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…s specified

fix error in pr comment: fastlane#20300 (comment)

…te option

should fix: fastlane#20300 (comment)

…perly

…+ docs

Krych · 2026-05-12T09:25:32Z

iBotPeaches there was conflict I resolved. Any option to take a look again?

iBotPeaches · 2026-05-12T11:58:01Z

@Krych - I added Copilot who found a few things above

- Remove unused `localizations` variable and parameter from UploadAppClipDefaultExperienceHeaderImages#upload - Fix operator precedence bug: `or` → `||` in has_options_specified assignment so action-only input is correctly detected - Fix wrong hash key in resolve_app_clip_review_info_path: was checking app_review_information instead of app_clip_review_information, which prevented loading App Clip review info from the filesystem - Fix transform_keys called before Hash check in app_clip_review_information: move kind_of?(Hash) guard before transform_keys to avoid NoMethodError - Fix nil crash in AppClipHeaderImage.create: rescue now re-raises via UI.user_error! instead of silently continuing with a nil object - Fix nil dereference in update_app_clip_invocations: add early return when app_clip_build_bundle is nil - Fix AppClipDefaultExperience.get: change includes default from {} to nil to avoid producing an invalid API query - Rename AppClipDefaultExperienceLocalizations → AppClipDefaultExperienceLocalization (singular) to match file name and other model naming conventions; update all references Co-authored-by: Copilot <[email protected]>

iBotPeaches · 2026-05-12T13:03:16Z

thanks. Okay let me watch the current release for another 24-48h to wait for any regressions. I'll start off v2.235.0 with a bang of dropping Ruby 2.7 support & adding App Clips.

You just have some lint issues now.

…uble leak - AppClipHeaderImage.create rescue block now re-raises instead of swallowing the error and leaving app_clip_header_image as nil, which would have crashed on the next line - Build Manager #upload specs: add before(:each) to stub Spaceship::ConnectAPI.client to nil, preventing leaked doubles from spaceship_spec.rb (which stores a real client with expired let doubles as a class-level variable) from causing failures when running spaceship/spec and pilot/spec together Co-authored-by: Copilot <[email protected]>

Krych · 2026-05-12T14:58:38Z

thanks. Okay let me watch the current release for another 24-48h to wait for any regressions. I'll start off v2.235.0 with a bang of dropping Ruby 2.7 support & adding App Clips.

You just have some lint issues now.

fixed

Copilot

Pull request overview

Copilot reviewed 28 out of 30 changed files in this pull request and generated 5 comments.

iBotPeaches

very close! I missed more env names.

github-actions

Hey @Krych 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a month, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀"

iBotPeaches · 2026-05-15T13:26:16Z

End of an era (#19043 → #20300 → #21180 → #22041 → #29738 → this PR.)

Lets be sure to get some testing on master prior to next month's release to ensure this works for all parties using clips. Thanks for getting it across finish line.

Krych · 2026-05-19T08:04:15Z

End of an era (#19043 → #20300 → #21180 → #22041 → #29738 → this PR.)

Lets be sure to get some testing on master prior to next month's release to ensure this works for all parties using clips. Thanks for getting it across finish line.

I have successfully tested on master branch that submitting app with app clips worked ✅ Probably it would be nice to also test app without app clips, but unfortunately I do not have such possibility.

bassrock · 2026-05-20T19:47:49Z

Tested here too, working perfectly.

github-actions

Congratulations! 🎉 This was released as part of fastlane 2.235.0 🚀

github-actions Bot added tool: deliver tool: pilot tool: spaceship tool: action labels Apr 30, 2026

iBotPeaches requested a review from Copilot May 1, 2026 10:19

Copilot started reviewing on behalf of iBotPeaches May 1, 2026 10:20 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

blesson3 and others added 22 commits May 12, 2026 10:03

deliver: add option to specify app clips default experience metadata

8964271

deliver: handle app clip metadata copy from live version if no option…

eb4e901

…s specified

deliver: fix typo with variables

49e8045

deliver: fix issue with creating app clip default experience

3debf10

fix error in pr comment: fastlane#20300 (comment)

deliver: solidify using the create app clip default experience templa…

a19479d

…te option

tunes: fix setting body attributes incorrectly

78f9fb7

should fix: fastlane#20300 (comment)

deliver: remove redundant condition on return

bce0f78

deliver: add docs for added App Clip metadata options

01e6c6a

deliver: improve App Clip header image docs with a better screenshot

3d9c703

deliver: fix bug where app clip action attribute would not update pro…

40f1675

…perly

Fix not receiving all AppClipDefaultExperienceLocalizations

9a6fe4b

pilot: add option to specify beta app clip invocations

991c6ec

deliver: add option to specify app clip app store review information

e0b2858

deliver: add deliver download_app_clip_header_images command

9cdfcb6

deliver: add functionality to pull App Clip metadata from filesystem …

58b71bd

…+ docs

Fix upload app clip default experience metadata on skip_metadata

1eb2687

Fix crash when app clip metadata path is missing

08f1652

Fix upload app clip invocation urls

44e31fe

Adjust documentation for app_clip_review_information

cf2d564

Fix lint issues

2388e8a

Make "app_clip_default_experience_metadata_path" optional

abbdb2e

fix: existing failing tests

6334c8f

Krych force-pushed the pilot-app-clips branch from b596166 to 2a0a4ee Compare May 12, 2026 12:36

iBotPeaches reviewed May 14, 2026

View reviewed changes

Comment thread deliver/lib/deliver/options.rb Outdated

Comment thread deliver/lib/deliver/options.rb Outdated

Comment thread deliver/lib/deliver/options.rb

Comment thread .gitignore Outdated

Updated envs name with tool prefix and removed entry in gitignore file

2287cce

iBotPeaches requested a review from Copilot May 14, 2026 11:47

Copilot started reviewing on behalf of iBotPeaches May 14, 2026 11:47 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Krych added 2 commits May 15, 2026 08:15

Copilot code review fixes

66c4f4d

Copilot code review fix extending app store version

df1813e

iBotPeaches reviewed May 15, 2026

View reviewed changes

Comment thread pilot/lib/pilot/options.rb Outdated

Comment thread pilot/lib/pilot/options.rb Outdated

Env names update to include app clips info

abdf6ea

iBotPeaches changed the title ~~[spaceship][deliver][pilot] Add support for App Clips default experience metadata and review information (rebase of #29738)~~ [spaceship][deliver][pilot] Add support for App Clips default experience metadata and review information May 15, 2026

iBotPeaches approved these changes May 15, 2026

View reviewed changes

iBotPeaches merged commit aa161f9 into fastlane:master May 15, 2026
9 checks passed

github-actions Bot added the status: included-in-next-release label May 15, 2026

github-actions Bot reviewed May 15, 2026

View reviewed changes

github-actions Bot mentioned this pull request May 25, 2026

Version bump to 2.235.0 #30050

Merged

github-actions Bot reviewed May 26, 2026

View reviewed changes

github-actions Bot added status: released and removed status: included-in-next-release labels May 26, 2026

This was referenced May 26, 2026

[spaceship][deliver][pilot] Add support for App Clips default experience metadata and review information #29738

Closed

[spaceship][deliver][pilot] add support for app clips default experience metadata and review information #22041

Closed

Uh oh!

Conversation

Krych commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iBotPeaches commented May 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Krych commented May 12, 2026

Uh oh!

iBotPeaches commented May 12, 2026

Uh oh!

iBotPeaches commented May 12, 2026

Uh oh!

Krych commented May 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iBotPeaches left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

iBotPeaches commented May 15, 2026

Uh oh!

Krych commented May 19, 2026

Uh oh!

bassrock commented May 20, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

Krych commented Apr 30, 2026 •

edited

Loading