Skip to content

[Bot] Update docs for latest fastlane release 2.228.0 (actions.md, available-plugins.md) 🚀 #1282

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[Bot] Update docs for latest fastlane release 2.228.0 (actions.md, available-plugins.md) 🚀 #1282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f14114
Update docs for latest fastlane release 2.228.0 (actions.md, availabl…
rogerluan Jun 10, 2025
8483dba
Remove references to the late hipchat action.
rogerluan Jun 10, 2025
fd6df53
Remove the entire hipchat action page.
rogerluan Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 35 additions & 36 deletions docs/generated/actions.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/generated/actions/app_store_connect_api_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ app_store_connect_api_key(
Key | Description | Default
----|-------------|--------
`key_id` | The key ID |
`issuer_id` | The issuer ID |
`issuer_id` | The issuer ID. It can be nil if the key is individual API key |
`key_filepath` | The path to the key p8 file |
`key_content` | The content of the key p8 file |
`is_key_content_base64` | Whether :key_content is Base64 encoded or not | `false`
Expand Down
9 changes: 5 additions & 4 deletions docs/generated/actions/appstore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,7 @@ The available options:

- 'ios'
- 'appletvos'
- 'xros'
- 'osx'


Expand Down Expand Up @@ -444,12 +445,12 @@ end

Omit `build_number` to let _fastlane_ automatically select the latest build number for the current version being edited for release from App Store Connect.

### Compliance and IDFA settings
### Compliance settings

Use the `submission_information` parameter for additional submission specifiers, including compliance and IDFA settings. Look at the Spaceship's [`app_submission.rb`](https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/tunes/app_submission.rb) file for options. See [this example](https://github.com/artsy/eigen/blob/faa02e2746194d8d7c11899474de9c517435eca4/fastlane/Fastfile#L131-L149).
Use the `submission_information` parameter for additional submission specifiers, including compliance settings. Look at the Spaceship's [`app_submission.rb`](https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/tunes/app_submission.rb) file for options. See [this example](https://github.com/artsy/eigen/blob/faa02e2746194d8d7c11899474de9c517435eca4/fastlane/Fastfile#L131-L149).

```no-highlight
fastlane deliver submit_build --build_number 830 --submission_information "{\"export_compliance_uses_encryption\": false, \"add_id_info_uses_idfa\": false }"
fastlane deliver submit_build --build_number 830 --submission_information "{\"export_compliance_uses_encryption\": false }"
```

### App Privacy Details
Expand Down Expand Up @@ -843,7 +844,7 @@ Key | Description | Default
`reset_ratings` | Reset the summary rating when you release a new version of the application | `false`
`price_tier` | The price tier of this application |
`app_rating_config_path` | Path to the app rating's config |
`submission_information` | Extra information for the submission (e.g. compliance specifications, IDFA settings) |
`submission_information` | Extra information for the submission (e.g. compliance specifications) |
`team_id` | The ID of your App Store Connect team if you're in multiple teams | [*](#parameters-legend-dynamic)
`team_name` | The name of your App Store Connect team if you're in multiple teams | [*](#parameters-legend-dynamic)
`dev_portal_team_id` | The short ID of your Developer Portal team, if you're in multiple teams. Different from your iTC team ID! | [*](#parameters-legend-dynamic)
Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/build_app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ Key | Description | Default
`skip_package_dependencies_resolution` | Skips resolution of Swift Package Manager dependencies | `false`
`disable_package_automatic_updates` | Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file | `false`
`use_system_scm` | Lets xcodebuild use system's scm configuration | `false`
`package_authorization_provider` | Lets xcodebuild use a specified package authorization provider (keychain\|netrc) |

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/build_ios_app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,7 @@ Key | Description | Default
`skip_package_dependencies_resolution` | Skips resolution of Swift Package Manager dependencies | `false`
`disable_package_automatic_updates` | Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file | `false`
`use_system_scm` | Lets xcodebuild use system's scm configuration | `false`
`package_authorization_provider` | Lets xcodebuild use a specified package authorization provider (keychain\|netrc) |

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/build_mac_app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@ Key | Description | Default
`skip_package_dependencies_resolution` | Skips resolution of Swift Package Manager dependencies | `false`
`disable_package_automatic_updates` | Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file | `false`
`use_system_scm` | Lets xcodebuild use system's scm configuration | `false`
`package_authorization_provider` | Lets xcodebuild use a specified package authorization provider (keychain\|netrc) |

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/capture_ios_screenshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ Key | Description | Default
`cloned_source_packages_path` | Sets a custom path for Swift Package Manager dependencies |
`skip_package_dependencies_resolution` | Skips resolution of Swift Package Manager dependencies | `false`
`disable_package_automatic_updates` | Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file | `false`
`package_authorization_provider` | Lets xcodebuild use a specified package authorization provider (keychain\|netrc) |
`testplan` | The testplan associated with the scheme that should be used for testing |
`only_testing` | Array of strings matching Test Bundle/Test Suite/Test Cases to run |
`skip_testing` | Array of strings matching Test Bundle/Test Suite/Test Cases to skip |
Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/capture_screenshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ Key | Description | Default
`cloned_source_packages_path` | Sets a custom path for Swift Package Manager dependencies |
`skip_package_dependencies_resolution` | Skips resolution of Swift Package Manager dependencies | `false`
`disable_package_automatic_updates` | Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file | `false`
`package_authorization_provider` | Lets xcodebuild use a specified package authorization provider (keychain\|netrc) |
`testplan` | The testplan associated with the scheme that should be used for testing |
`only_testing` | Array of strings matching Test Bundle/Test Suite/Test Cases to run |
`skip_testing` | Array of strings matching Test Bundle/Test Suite/Test Cases to skip |
Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/changelog_from_git_commits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Key | Description | Default
`quiet` | Whether or not to disable changelog output | `false`
`include_merges` | **DEPRECATED!** Use `:merge_commit_filtering` instead - Whether or not to include any commits that are merges |
`merge_commit_filtering` | Controls inclusion of merge commits when collecting the changelog. Valid values: 'include_merges', 'exclude_merges', 'only_include_merges' | `include_merges`
`app_path` | Scopes the changelog to a specific subdirectory of the repository |

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
9 changes: 5 additions & 4 deletions docs/generated/actions/deliver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,7 @@ The available options:

- 'ios'
- 'appletvos'
- 'xros'
- 'osx'


Expand Down Expand Up @@ -444,12 +445,12 @@ end

Omit `build_number` to let _fastlane_ automatically select the latest build number for the current version being edited for release from App Store Connect.

### Compliance and IDFA settings
### Compliance settings

Use the `submission_information` parameter for additional submission specifiers, including compliance and IDFA settings. Look at the Spaceship's [`app_submission.rb`](https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/tunes/app_submission.rb) file for options. See [this example](https://github.com/artsy/eigen/blob/faa02e2746194d8d7c11899474de9c517435eca4/fastlane/Fastfile#L131-L149).
Use the `submission_information` parameter for additional submission specifiers, including compliance settings. Look at the Spaceship's [`app_submission.rb`](https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/tunes/app_submission.rb) file for options. See [this example](https://github.com/artsy/eigen/blob/faa02e2746194d8d7c11899474de9c517435eca4/fastlane/Fastfile#L131-L149).

```no-highlight
fastlane deliver submit_build --build_number 830 --submission_information "{\"export_compliance_uses_encryption\": false, \"add_id_info_uses_idfa\": false }"
fastlane deliver submit_build --build_number 830 --submission_information "{\"export_compliance_uses_encryption\": false }"
```

### App Privacy Details
Expand Down Expand Up @@ -843,7 +844,7 @@ Key | Description | Default
`reset_ratings` | Reset the summary rating when you release a new version of the application | `false`
`price_tier` | The price tier of this application |
`app_rating_config_path` | Path to the app rating's config |
`submission_information` | Extra information for the submission (e.g. compliance specifications, IDFA settings) |
`submission_information` | Extra information for the submission (e.g. compliance specifications) |
`team_id` | The ID of your App Store Connect team if you're in multiple teams | [*](#parameters-legend-dynamic)
`team_name` | The name of your App Store Connect team if you're in multiple teams | [*](#parameters-legend-dynamic)
`dev_portal_team_id` | The short ID of your Developer Portal team, if you're in multiple teams. Different from your iTC team ID! | [*](#parameters-legend-dynamic)
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/actions/download_dsyms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Key | Description | Default
`app_identifier` | The bundle identifier of your app | [*](#parameters-legend-dynamic)
`team_id` | The ID of your App Store Connect team if you're in multiple teams | [*](#parameters-legend-dynamic)
`team_name` | The name of your App Store Connect team if you're in multiple teams | [*](#parameters-legend-dynamic)
`platform` | The app platform for dSYMs you wish to download (ios, appletvos) | `:ios`
`platform` | The app platform for dSYMs you wish to download (ios, xros, appletvos) | `:ios`
`version` | The app version for dSYMs you wish to download, pass in 'latest' to download only the latest build's dSYMs or 'live' to download only the live version dSYMs |
`build_number` | The app build_number for dSYMs you wish to download |
`min_version` | The minimum app version for dSYMs you wish to download |
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/actions/get_provisioning_profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Key | Description | Default
`skip_certificate_verification` | Skips the verification of the certificates for every existing profiles. This will make sure the provisioning profile can be used on the local machine | [*](#parameters-legend-dynamic)
`platform` | Set the provisioning profile's platform (i.e. ios, tvos, macos, catalyst) | `ios`
`readonly` | Only fetch existing profile, don't generate new ones | `false`
`template_name` | The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. "Apple Pay Pass Suppression Development") |
`template_name` | **DEPRECATED!** Removed since May 2025 on App Store Connect API OpenAPI v3.8.0 - Learn more: https://docs.fastlane.tools/actions/match/#managed-capabilities - The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. "Apple Pay Pass Suppression Development") |
`fail_on_name_taken` | Should the command fail if it was about to create a duplicate of an existing provisioning profile. It can happen due to issues on Apple Developer Portal, when profile to be recreated was not properly deleted first | `false`
`cached_certificates` | A list of cached certificates |
`cached_devices` | A list of cached devices |
Expand Down
1 change: 1 addition & 0 deletions docs/generated/actions/gym.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ Key | Description | Default
`skip_package_dependencies_resolution` | Skips resolution of Swift Package Manager dependencies | `false`
`disable_package_automatic_updates` | Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file | `false`
`use_system_scm` | Lets xcodebuild use system's scm configuration | `false`
`package_authorization_provider` | Lets xcodebuild use a specified package authorization provider (keychain\|netrc) |

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
97 changes: 0 additions & 97 deletions docs/generated/actions/hipchat.md
View file
Open in desktop

This file was deleted.

4 changes: 3 additions & 1 deletion docs/generated/actions/import_from_git.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ import_from_git(
branch: "HEAD", # The branch to checkout on the repository.
path: "fastlane/Fastfile", # The path of the Fastfile in the repository.
version: [">= 1.1.0", "< 2.0.0"], # The version to checkout on the repository. Multiple conditions can be used to select the latest version within constraints.
cache_path: "~/.cache/fastlane/imported" # A directory in which the repository will be added, which means that it will not be cloned again on subsequent calls.
cache_path: "~/.cache/fastlane/imported", # A directory in which the repository will be added, which means that it will not be cloned again on subsequent calls.
git_extra_headers: ["Authorization: Basic <YOUR BASE64 KEY>", "Cache-Control: no-cache"]
)
```

Expand All @@ -56,6 +57,7 @@ Key | Description | Default
`path` | The path of the Fastfile in the repository | `fastlane/Fastfile`
`version` | The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the latest version within constraints |
`cache_path` | The path to a directory where the repository should be cloned into. Defaults to `nil`, which causes the repository to be cloned on every call, to a temporary directory |
`git_extra_headers` | An optional list of custom HTTP headers to access the git repo (`Authorization: Basic <YOUR BASE64 KEY>`, `Cache-Control: no-cache`, etc.) | `[]`

<em id="parameters-legend-dynamic">* = default value is dependent on the user's system</em>

Expand Down
Loading