├── .ci
└── bundler_version.rb
├── .circleci
└── config.yml
├── .github
├── ISSUE_TEMPLATE.md
└── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── .python-version
├── .rubocop.yml
├── .ruby-version
├── Dangerfile
├── Gemfile
├── Gemfile.lock
├── Pipfile
├── Pipfile.lock
├── README.md
├── docs
├── advanced.md
├── advanced
│ ├── Appfile.md
│ ├── Fastfile.md
│ ├── actions.md
│ ├── fastlane.md
│ ├── lanes.md
│ └── other.md
├── app-store-connect-api.md
├── best-practices
│ ├── continuous-integration.md
│ ├── continuous-integration
│ │ ├── appcircle.md
│ │ ├── azure-devops.md
│ │ ├── bamboo.md
│ │ ├── bitrise.md
│ │ ├── circle-ci.md
│ │ ├── codebuild.md
│ │ ├── codemagic.md
│ │ ├── github.md
│ │ ├── gitlab.md
│ │ ├── jenkins.md
│ │ ├── semaphore.md
│ │ └── travis.md
│ ├── keys.md
│ ├── source-control.md
│ └── xcodebuild-formatters.md
├── codesigning
│ ├── common-issues.md
│ ├── getting-started.md
│ ├── troubleshooting.md
│ └── xcode-project.md
├── create-action.md
├── css
│ ├── breadcrumbs.css
│ ├── code.css
│ ├── fabric.css
│ ├── fastlane.css
│ └── sidenav.css
├── faqs.md
├── generated
│ ├── actions.md
│ ├── actions
│ │ ├── adb.md
│ │ ├── adb_devices.md
│ │ ├── add_extra_platforms.md
│ │ ├── add_git_tag.md
│ │ ├── app_store_build_number.md
│ │ ├── app_store_connect_api_key.md
│ │ ├── appaloosa.md
│ │ ├── appetize.md
│ │ ├── appetize_viewing_url_generator.md
│ │ ├── appium.md
│ │ ├── appledoc.md
│ │ ├── appstore.md
│ │ ├── apteligent.md
│ │ ├── artifactory.md
│ │ ├── automatic_code_signing.md
│ │ ├── backup_file.md
│ │ ├── backup_xcarchive.md
│ │ ├── badge.md
│ │ ├── build_and_upload_to_appetize.md
│ │ ├── build_android_app.md
│ │ ├── build_app.md
│ │ ├── build_ios_app.md
│ │ ├── build_mac_app.md
│ │ ├── bundle_install.md
│ │ ├── capture_android_screenshots.md
│ │ ├── capture_ios_screenshots.md
│ │ ├── capture_screenshots.md
│ │ ├── carthage.md
│ │ ├── cert.md
│ │ ├── changelog_from_git_commits.md
│ │ ├── chatwork.md
│ │ ├── check_app_store_metadata.md
│ │ ├── clean_build_artifacts.md
│ │ ├── clean_cocoapods_cache.md
│ │ ├── clear_derived_data.md
│ │ ├── clipboard.md
│ │ ├── cloc.md
│ │ ├── clubmate.md
│ │ ├── cocoapods.md
│ │ ├── commit_github_file.md
│ │ ├── commit_version_bump.md
│ │ ├── copy_artifacts.md
│ │ ├── create_app_on_managed_play_store.md
│ │ ├── create_app_online.md
│ │ ├── create_keychain.md
│ │ ├── create_pull_request.md
│ │ ├── create_xcframework.md
│ │ ├── danger.md
│ │ ├── debug.md
│ │ ├── default_platform.md
│ │ ├── delete_keychain.md
│ │ ├── deliver.md
│ │ ├── deploygate.md
│ │ ├── dotgpg_environment.md
│ │ ├── download.md
│ │ ├── download_app_privacy_details_from_app_store.md
│ │ ├── download_dsyms.md
│ │ ├── download_from_play_store.md
│ │ ├── download_universal_apk_from_google_play.md
│ │ ├── dsym_zip.md
│ │ ├── echo.md
│ │ ├── ensure_bundle_exec.md
│ │ ├── ensure_env_vars.md
│ │ ├── ensure_git_branch.md
│ │ ├── ensure_git_status_clean.md
│ │ ├── ensure_no_debug_code.md
│ │ ├── ensure_xcode_version.md
│ │ ├── environment_variable.md
│ │ ├── erb.md
│ │ ├── fastlane_version.md
│ │ ├── flock.md
│ │ ├── frame_screenshots.md
│ │ ├── frameit.md
│ │ ├── gcovr.md
│ │ ├── get_build_number.md
│ │ ├── get_build_number_repository.md
│ │ ├── get_certificates.md
│ │ ├── get_github_release.md
│ │ ├── get_info_plist_value.md
│ │ ├── get_ipa_info_plist_value.md
│ │ ├── get_managed_play_store_publishing_rights.md
│ │ ├── get_provisioning_profile.md
│ │ ├── get_push_certificate.md
│ │ ├── get_version_number.md
│ │ ├── git_add.md
│ │ ├── git_branch.md
│ │ ├── git_commit.md
│ │ ├── git_pull.md
│ │ ├── git_remote_branch.md
│ │ ├── git_submodule_update.md
│ │ ├── git_tag_exists.md
│ │ ├── github_api.md
│ │ ├── google_play_track_release_names.md
│ │ ├── google_play_track_version_codes.md
│ │ ├── gradle.md
│ │ ├── gym.md
│ │ ├── hg_add_tag.md
│ │ ├── hg_commit_version_bump.md
│ │ ├── hg_ensure_clean_status.md
│ │ ├── hg_push.md
│ │ ├── hipchat.md
│ │ ├── hockey.md
│ │ ├── ifttt.md
│ │ ├── import.md
│ │ ├── import_certificate.md
│ │ ├── import_from_git.md
│ │ ├── increment_build_number.md
│ │ ├── increment_version_number.md
│ │ ├── install_on_device.md
│ │ ├── install_provisioning_profile.md
│ │ ├── install_xcode_plugin.md
│ │ ├── installr.md
│ │ ├── ipa.md
│ │ ├── is_ci.md
│ │ ├── jazzy.md
│ │ ├── jira.md
│ │ ├── lane_context.md
│ │ ├── last_git_commit.md
│ │ ├── last_git_tag.md
│ │ ├── latest_testflight_build_number.md
│ │ ├── lcov.md
│ │ ├── mailgun.md
│ │ ├── make_changelog_from_jenkins.md
│ │ ├── match.md
│ │ ├── match_nuke.md
│ │ ├── min_fastlane_version.md
│ │ ├── modify_services.md
│ │ ├── nexus_upload.md
│ │ ├── notarize.md
│ │ ├── notification.md
│ │ ├── notify.md
│ │ ├── number_of_commits.md
│ │ ├── oclint.md
│ │ ├── onesignal.md
│ │ ├── opt_out_crash_reporting.md
│ │ ├── opt_out_usage.md
│ │ ├── pem.md
│ │ ├── pilot.md
│ │ ├── plugin_scores.md
│ │ ├── pod_lib_lint.md
│ │ ├── pod_push.md
│ │ ├── podio_item.md
│ │ ├── precheck.md
│ │ ├── println.md
│ │ ├── produce.md
│ │ ├── prompt.md
│ │ ├── push_git_tags.md
│ │ ├── push_to_git_remote.md
│ │ ├── puts.md
│ │ ├── read_podspec.md
│ │ ├── recreate_schemes.md
│ │ ├── register_device.md
│ │ ├── register_devices.md
│ │ ├── reset_git_repo.md
│ │ ├── reset_simulator_contents.md
│ │ ├── resign.md
│ │ ├── restore_file.md
│ │ ├── rocket.md
│ │ ├── rspec.md
│ │ ├── rsync.md
│ │ ├── rubocop.md
│ │ ├── ruby_version.md
│ │ ├── run_tests.md
│ │ ├── s3.md
│ │ ├── say.md
│ │ ├── scan.md
│ │ ├── scp.md
│ │ ├── screengrab.md
│ │ ├── set_build_number_repository.md
│ │ ├── set_changelog.md
│ │ ├── set_github_release.md
│ │ ├── set_info_plist_value.md
│ │ ├── set_pod_key.md
│ │ ├── setup_ci.md
│ │ ├── setup_circle_ci.md
│ │ ├── setup_jenkins.md
│ │ ├── setup_travis.md
│ │ ├── sh.md
│ │ ├── sigh.md
│ │ ├── skip_docs.md
│ │ ├── slack.md
│ │ ├── slack_train.md
│ │ ├── slack_train_crash.md
│ │ ├── slack_train_start.md
│ │ ├── slather.md
│ │ ├── snapshot.md
│ │ ├── sonar.md
│ │ ├── sourcedocs.md
│ │ ├── spaceship_logs.md
│ │ ├── spaceship_stats.md
│ │ ├── splunkmint.md
│ │ ├── spm.md
│ │ ├── ssh.md
│ │ ├── supply.md
│ │ ├── swiftlint.md
│ │ ├── sync_code_signing.md
│ │ ├── team_id.md
│ │ ├── team_name.md
│ │ ├── testfairy.md
│ │ ├── testflight.md
│ │ ├── trainer.md
│ │ ├── tryouts.md
│ │ ├── twitter.md
│ │ ├── typetalk.md
│ │ ├── unlock_keychain.md
│ │ ├── update_app_group_identifiers.md
│ │ ├── update_app_identifier.md
│ │ ├── update_code_signing_settings.md
│ │ ├── update_fastlane.md
│ │ ├── update_icloud_container_identifiers.md
│ │ ├── update_info_plist.md
│ │ ├── update_keychain_access_groups.md
│ │ ├── update_plist.md
│ │ ├── update_project_code_signing.md
│ │ ├── update_project_provisioning.md
│ │ ├── update_project_team.md
│ │ ├── update_urban_airship_configuration.md
│ │ ├── update_url_schemes.md
│ │ ├── upload_app_privacy_details_to_app_store.md
│ │ ├── upload_symbols_to_crashlytics.md
│ │ ├── upload_symbols_to_sentry.md
│ │ ├── upload_to_app_store.md
│ │ ├── upload_to_play_store.md
│ │ ├── upload_to_play_store_internal_app_sharing.md
│ │ ├── upload_to_testflight.md
│ │ ├── validate_play_store_json_key.md
│ │ ├── verify_build.md
│ │ ├── verify_pod_keys.md
│ │ ├── verify_xcode.md
│ │ ├── version_bump_podspec.md
│ │ ├── version_get_podspec.md
│ │ ├── xcarchive.md
│ │ ├── xcbuild.md
│ │ ├── xcclean.md
│ │ ├── xcexport.md
│ │ ├── xcode_install.md
│ │ ├── xcode_select.md
│ │ ├── xcode_server_get_assets.md
│ │ ├── xcodebuild.md
│ │ ├── xcodes.md
│ │ ├── xcov.md
│ │ ├── xctest.md
│ │ ├── xctool.md
│ │ ├── xcversion.md
│ │ └── zip.md
│ └── available-plugins.md
├── getting-started
│ ├── android
│ │ ├── beta-deployment.md
│ │ ├── release-deployment.md
│ │ ├── running-tests.md
│ │ ├── screenshots.md
│ │ └── setup.md
│ ├── cross-platform
│ │ ├── flutter.md
│ │ ├── nativescript.md
│ │ └── react-native.md
│ └── ios
│ │ ├── appstore-deployment.md
│ │ ├── authentication.md
│ │ ├── beta-deployment.md
│ │ ├── fastlane-swift.md
│ │ ├── running-tests.md
│ │ ├── screenshots.md
│ │ └── setup.md
├── img
│ ├── actions
│ │ ├── Beta-Group-Alias.png
│ │ ├── Beta-Groups-Nav.png
│ │ ├── FrameitGit.gif
│ │ ├── GridExampleScreenshot.png
│ │ ├── MacExample.png
│ │ ├── PEMRecording.gif
│ │ ├── PilotTextTransparent.png
│ │ ├── PilotTextTransparentSmall.png
│ │ ├── PilotTextWhite.png
│ │ ├── PilotTransparent.png
│ │ ├── QuickLookScreenshot-App.png
│ │ ├── QuickLookScreenshot-Provision.png
│ │ ├── QuickLookScreenshot.png
│ │ ├── ScreenshotsBig.png
│ │ ├── ScreenshotsOverview.png
│ │ ├── SignErrors.png
│ │ ├── UDIDPrint.png
│ │ ├── cert.gif
│ │ ├── cert.png
│ │ ├── deliver.png
│ │ ├── deliver_metadata.png
│ │ ├── deliver_screenshots.png
│ │ ├── frameit.png
│ │ ├── github_repo.png
│ │ ├── gym.gif
│ │ ├── gym.png
│ │ ├── gymScreenshot.png
│ │ ├── htmlPage.png
│ │ ├── htmlPagePreview.jpg
│ │ ├── htmlPagePreviewFade.jpg
│ │ ├── match.png
│ │ ├── match_appstore_small.gif
│ │ ├── match_init.gif
│ │ ├── match_nuke.gif
│ │ ├── pem.png
│ │ ├── pilot.ai
│ │ ├── precheck.gif
│ │ ├── precheck.png
│ │ ├── produce.png
│ │ ├── running-screengrab.gif
│ │ ├── scan.png
│ │ ├── scanHTML.png
│ │ ├── scanHTMLFailing.png
│ │ ├── scanScreenshot.png
│ │ ├── screengrab.png
│ │ ├── sigh.png
│ │ ├── sighRecording.gif
│ │ ├── slack.png
│ │ ├── snapshot.gif
│ │ ├── snapshot.png
│ │ ├── supply.png
│ │ └── testSummary.png
│ ├── app-privacy-details-action-questions.png
│ ├── app-privacy-details-action-upload.png
│ ├── app-privacy-details-app-store-connect.png
│ ├── best-practices
│ │ └── JenkinsIntegration.png
│ ├── codesigning
│ │ ├── KeychainPrivateKey.png
│ │ ├── ProvisioningProfileSelectionManual.png
│ │ ├── ProvisioningProfileSelectionNew.png
│ │ ├── XcodeAutomaticallyManageSigning.png
│ │ └── auto_signing.png
│ ├── contributing
│ │ └── UI.png
│ ├── fastlane_text.png
│ ├── favicon.ico
│ └── getting-started
│ │ ├── android
│ │ ├── creating-service-account.png
│ │ ├── fastlane-init.png
│ │ ├── running-screengrab.gif
│ │ ├── screengrab-results.png
│ │ └── supply-init.png
│ │ └── ios
│ │ ├── boarding-screenshot.png
│ │ ├── fastlane-init.png
│ │ ├── frameit-results.png
│ │ ├── htmlPagePreviewFade.jpg
│ │ └── snapshot.gif
├── includes
│ ├── google-credentials.md
│ ├── installing-fastlane-ios.md
│ ├── installing-fastlane.md
│ └── setup-fastlane-header.md
├── index.md
├── plugins
│ ├── available-plugins.md
│ ├── create-plugin.md
│ ├── plugins-troubleshooting.md
│ └── using-plugins.md
└── uploading-app-privacy-details.md
├── fastlane
├── Fastfile
├── README.md
└── actions
│ └── test_sample_code.rb
├── hooks.py
├── mkdocs.yml
├── plugin_scores_cache.yml
├── scripts
└── ci
│ ├── available_redirects.rb
│ ├── deploy.sh
│ └── generate_redirects.rb
└── theme
├── base.html
├── breadcrumbs.html
├── footer.html
├── img
└── favicon.ico
├── nav.html
├── searchbox.html
└── toc.html
/.ci/bundler_version.rb:
--------------------------------------------------------------------------------
1 | # /usr/bin/env ruby
2 | file = File.join(__dir__, "..", "Gemfile.lock")
3 | lines = File.read(file).split("\n")
4 | idx = lines.index { |l| l == "BUNDLED WITH" }
5 | puts lines[idx + 1].strip
6 |
--------------------------------------------------------------------------------
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | version: 2.0
2 |
3 | jobs:
4 | "Test":
5 | docker:
6 | - image: fastlanetools/ci:0.4.0
7 | working_directory: ~/code
8 | steps:
9 | - checkout
10 | - run: sudo pip3 install pipenv
11 | - run: pipenv install
12 | - run: gem install bundler -v $(ruby .ci/bundler_version.rb)
13 | - run: bundle update
14 | - run: pipenv run bundle exec fastlane test
15 | - run: bundle exec rubocop
16 | - run: bundle exec danger || echo "danger failed, moving on"
17 | "Deploy":
18 | docker:
19 | - image: fastlanetools/ci:0.4.0
20 | working_directory: ~/code
21 | steps:
22 | - checkout
23 | - run: sudo pip3 install pipenv
24 | - run: pipenv install
25 | - run: gem install bundler -v $(ruby .ci/bundler_version.rb)
26 | - run: bundle update
27 | - run: pipenv run ./scripts/ci/deploy.sh
28 |
29 | workflows:
30 | version: 2
31 | build:
32 | jobs:
33 | - "Test"
34 | - "Deploy":
35 | filters:
36 | branches:
37 | only: master
38 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | Issues submitted here should consist of bugs/features of our [docs site](https://docs.fastlane.tools/).
2 | If you're looking to submit an issue (bug/question/feature) about _fastlane_ itself, please do so in the [main repo](https://github.com/fastlane/fastlane/issues).
3 |
4 |
--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
5 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | site/
3 | /fastlane/report.xml
4 | .keys
5 | *.swp
6 | vendor/bundle
7 |
--------------------------------------------------------------------------------
/.python-version:
--------------------------------------------------------------------------------
1 | 3.8.13
2 |
--------------------------------------------------------------------------------
/.ruby-version:
--------------------------------------------------------------------------------
1 | 3.1.1
2 |
--------------------------------------------------------------------------------
/Dangerfile:
--------------------------------------------------------------------------------
1 | require "yaml"
2 |
3 | # Make sure no page got removed
4 | if git.diff_for_file("mkdocs.yml")
5 | warn("mkdocs.yml was modified - make sure no modification was made by mistake")
6 |
7 | patch = git.diff_for_file("mkdocs.yml").patch
8 |
9 | # we only care about the pages, not the other config
10 | # this is probably the most reliable way to detect if it's a page (ends with .md)
11 | lines = patch.split("\n").delete_if { |a| !a.strip.end_with?(".md") }
12 |
13 | lines.each do |current_line|
14 | if current_line.start_with?("-")
15 | page_name = current_line.match(/\-.*\- (.*)/)[1]
16 | warn("It seems like the page #{page_name} got removed from mkdocs.yml, we don't want to remove any public links. Instead please add a redirect to the new page.")
17 | end
18 | end
19 | end
20 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source("https://rubygems.org")
2 |
3 | gem "danger", "~> 8" # Fixed on 8.x because 9.x uses Octokit 5.x which doesn't support Ruby 2.6, which is needed to run verify_docs lane in fastlane's main repo.
4 | gem "fastlane", git: "https://github.com/fastlane/fastlane"
5 | gem "rubocop", "0.49.1"
6 | gem "xcov" # Needed for testing sample code
7 |
--------------------------------------------------------------------------------
/Pipfile:
--------------------------------------------------------------------------------
1 | [[source]]
2 | url = "https://pypi.python.org/simple"
3 | verify_ssl = true
4 | name = "pypi"
5 |
6 | [packages]
7 | markdown-include = "*"
8 | mdx-truly-sane-lists = "*"
9 | mkdocs = "*"
10 | mkdocs-bootstrap = "*"
11 | mkdocs-bootswatch = "*"
12 | mkdocs-simple-hooks = "*"
13 | pymdown-extensions = "*"
14 | importlib-metadata = "*"
15 | typing-extensions = "*"
16 |
17 | [dev-packages]
18 |
19 | [requires]
20 | python_version = "3"
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # fastlane docs
2 |
3 | This repository contains all documentation for fastlane. You can access the `.md` files inside the [docs](docs) folder.
4 |
5 | To preview the updated documentation locally, just clone the repo, modify the file, and run the command. Note that some of the files are in [generated](docs/generated) folder and are later copied with `mkdocs` pre-build hook.
6 |
7 | ```
8 | mkdocs serve
9 | ```
10 |
11 | The live version is available on [docs.fastlane.tools](https://docs.fastlane.tools).
12 |
13 | ## Why new docs?
14 |
15 | You can find more information [here](https://github.com/fastlane/docs/issues/5)
16 |
17 | ## Deploy changes
18 |
19 | Once a pull request (PR) is merged into master, the latest version will automatically be deployed to [docs.fastlane.tools](https://docs.fastlane.tools) by one of the hard-working fastlane bots. There is no need to perform any manual actions. The resulting HTML files are stored in the [`gh-pages`](https://github.com/fastlane/docs/tree/gh-pages) branch.
20 |
21 | ## Installation of [mkdocs](http://www.mkdocs.org/)
22 |
23 | ```sh
24 | brew install python3 # if you don't have pip already
25 | brew install pipenv
26 | pipenv --three
27 | # install dependencies from Pipfile.lock and run shell
28 | pipenv install
29 | pipenv shell
30 | ```
31 |
32 | ## Adding a Python dependency
33 |
34 | Likely, to add a [Markdown extension](https://pythonhosted.org/Markdown/extensions/), install it with `pipenv install ` after making sure the virtualenv is loaded (`pipenv shell`).
35 |
36 | ## Troubleshooting local docs server
37 |
38 | Running a local server with `mkdocs serve`, it may take several minutes to start. This delay is because `mkdocs` needs some time to read the `available-plugins.md` file. It can be confirmed by running `mkdocs serve --verbose` as `mkdocs` is stuck at reading this file.
39 |
40 | For testing changes on pages other than the list of available plugins, it is convenient to edit `docs/generated/available-plugins.md`, removing all of its content and saving the file before running `mkdocs serve`.
41 |
--------------------------------------------------------------------------------
/docs/advanced/Appfile.md:
--------------------------------------------------------------------------------
1 | {!docs/includes/setup-fastlane-header.md!}
2 |
3 | # Appfile
4 |
5 | The `Appfile` stores useful information that are used across all _fastlane_ tools like your *Apple ID* or the application *Bundle Identifier*, to deploy your lanes faster and tailored on your project needs.
6 |
7 | The `Appfile` has to be inside your `./fastlane` directory.
8 |
9 | By default an `Appfile` looks like:
10 |
11 | ```ruby
12 | app_identifier "net.sunapps.1" # The bundle identifier of your app
13 | apple_id "felix@krausefx.com" # Your Apple email address
14 |
15 | # You can uncomment the lines below and add your own
16 | # team selection in case you're in multiple teams
17 | # team_name "Felix Krause"
18 | # team_id "Q2CBPJ58CA"
19 |
20 | # To select a team for App Store Connect use
21 | # itc_team_name "Company Name"
22 | # itc_team_id "18742801"
23 | ```
24 |
25 | If you have different credentials for App Store Connect and the Apple Developer Portal use the following code:
26 |
27 | ```ruby
28 | app_identifier "tools.fastlane.app" # The bundle identifier of your app
29 |
30 | apple_dev_portal_id "portal@company.com" # Apple Developer Account
31 | itunes_connect_id "tunes@company.com" # App Store Connect Account
32 |
33 | team_id "Q2CBPJ58CA" # Developer Portal Team ID
34 | itc_team_id "18742801" # App Store Connect Team ID
35 | ```
36 |
37 | If your project has different bundle identifiers per environment (i.e. beta, app store), you can define that by using `for_platform` and/or `for_lane` block declaration.
38 |
39 | ```ruby
40 | app_identifier "net.sunapps.1"
41 | apple_id "felix@krausefx.com"
42 | team_id "Q2CBPJ58CC"
43 |
44 | for_platform :ios do
45 | team_id '123' # for all iOS related things
46 | for_lane :test do
47 | app_identifier 'com.app.test'
48 | end
49 | end
50 | ```
51 |
52 | You only have to use `for_platform` if you're using `platform [platform_name] do` in your `Fastfile`.
53 |
54 | _fastlane_ will always use the lane specific value if given, otherwise fall back to the value on the top of the file. Therefore, while driving the `:test` lane, this configuration is loaded:
55 |
56 | ```ruby
57 | app_identifier "com.app.test"
58 | apple_id "felix@krausefx.com"
59 | team_id "123"
60 | ```
61 |
62 | ## Accessing from fastlane
63 |
64 | If you want to access those values from within your `Fastfile` use
65 |
66 | ```ruby
67 | identifier = CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)
68 | team_id = CredentialsManager::AppfileConfig.try_fetch_value(:team_id)
69 | ```
--------------------------------------------------------------------------------
/docs/best-practices/continuous-integration/azure-devops.md:
--------------------------------------------------------------------------------
1 | # Azure DevOps (formerly known as: Visual Studio Team Services)
2 |
3 | Microsoft Visual Studio Team Services (VSTS) and Team Foundation Server (TFS) use _fastlane_ in their [Apple App Store](https://marketplace.visualstudio.com/items?itemName=ms-vsclient.app-store) extension.
4 |
5 | ## Getting Started
6 |
7 | Once you have created or retrieved credentials for your App Store account, then perform the following steps to automate releasing updates from a VSTS build or release definition:
8 |
9 | 1. Install the App Store extension from the VSTS Marketplace
10 | 1. Go to your VSTS or TFS project, click on the **Build** tab, and create a new build definition (the "+" icon) that is hooked up to your project's appropriate source repo
11 | 1. Click **Add build step...** and select the necessary tasks to generate your release assets (e.g. Gulp, Cordova Build)
12 | 1. Click **Add build step...** and select **App Store Release** from the **Deploy** category
13 | 1. Configure the **App Store Release** task with the desired authentication method, the generated IPA file path, and the desired release track.
14 |
15 | Now when you build, your app will automatically be published to _App Store Connect_!
16 |
17 | ## Configuring _fastlane_ versions
18 |
19 | The extension can be configured to install the latest version of _fastlane_ or a specific version of _fastlane_:
20 |
21 | 1. In the Build for your project, click on the **Apple App Store** task (supported in both `Apple App Store Release` and `Apple App Store Promote`), go to the **Advanced** section of the Task, click **Install fastlane**
22 | 1. Optionally, select **Specific Version** from `fastlane version`, and enter a specific version of _fastlane_
23 |
24 | ## More Information
25 |
26 | For more documentation, see the [Apple App Store](https://marketplace.visualstudio.com/items?itemName=ms-vsclient.app-store) in the Visual Studio Team Server marketplace.
27 |
--------------------------------------------------------------------------------
/docs/best-practices/continuous-integration/circle-ci.md:
--------------------------------------------------------------------------------
1 | # CircleCI Integration
2 |
3 | To run fastlane on CircleCI, first create a `Gemfile` in the root of your project with the following content:
4 |
5 | ```ruby
6 | # Gemfile
7 | source "https://rubygems.org"
8 |
9 | gem "fastlane"
10 | ```
11 |
12 | and run
13 |
14 | ```no-highlight
15 | gem install bundler && bundle update
16 | ```
17 |
18 | This will create a `Gemfile.lock` that defines all Ruby dependencies. Make sure
19 | to commit both files to version control.
20 |
21 | Next, add the following to your `Fastfile`:
22 |
23 | ```ruby
24 | # fastlane/Fastfile
25 |
26 | ...
27 | platform :ios do
28 | before_all do
29 | setup_circle_ci
30 | end
31 | ...
32 | end
33 | ```
34 |
35 | The `setup_circle_ci` _fastlane_ action will perform the following actions:
36 |
37 | * Create a new temporary keychain for use with
38 | [_match_](https://fastlane.tools/match) (see the [CircleCI code signing
39 | doc](https://circleci.com/docs/2.0/ios-codesigning/) for more details).
40 | * Switch _match_ to readonly mode to make sure CI does not create new
41 | code signing certificates or provisioning profiles.
42 | * Set up log and test result paths to be easily collectible.
43 |
44 | Next, create a `.circleci` directory in your project and add a
45 | `.circleci/config.yml` with the following content:
46 |
47 | ```yml
48 | # .circleci/config.yml
49 |
50 | version: 2.1
51 |
52 | orbs:
53 | ruby: circleci/ruby@1.2.0
54 |
55 | jobs:
56 | build:
57 | macos:
58 | xcode: "13.1.0"
59 | working_directory: /Users/distiller/project
60 | environment:
61 | FL_OUTPUT_DIR: output
62 | FASTLANE_LANE: test
63 | shell: /bin/bash --login -o pipefail
64 | steps:
65 | - checkout
66 | - ruby/install-deps
67 | - run:
68 | name: fastlane
69 | command: bundle exec fastlane $FASTLANE_LANE
70 | - store_artifacts:
71 | path: output
72 | - store_test_results:
73 | path: output/scan
74 | ```
75 |
76 | This will do the following:
77 |
78 | * Create and use a Ruby gems cache.
79 | * Run the test lane on all pushes.
80 | * Collect Junit test results and store log output in the Artifacts tab.
81 |
82 | Check out [the CircleCI iOS doc](https://circleci.com/docs/2.0/testing-ios/#example-configuration-for-using-fastlane-on-circleci) for more detailed examples of using fastlane on CircleCI.
83 |
--------------------------------------------------------------------------------
/docs/best-practices/continuous-integration/codebuild.md:
--------------------------------------------------------------------------------
1 | # AWS CodeBuild Integration
2 |
3 | Use [AWS CodeBuild Reserved Capacity Fleets](https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html) running on a macOS machine to build using _fastlane_.
4 |
5 | ## Repository setup
6 |
7 | First create a `Gemfile` in the root of your project with the following content:
8 |
9 | ```ruby
10 | source 'https://rubygems.org'
11 |
12 | gem 'fastlane'
13 | ```
14 |
15 | Add a buildspec.yml file to your repository with the following content:
16 |
17 | ```yml
18 | version: 0.2
19 |
20 | env:
21 | secrets-manager:
22 | MATCH_PASSWORD: :::
23 | FASTLANE_SESSION: :::
24 |
25 | phases:
26 | install:
27 | commands:
28 | - bundle install
29 | build:
30 | commands:
31 | - bundle exec fastlane beta
32 | ```
33 |
34 | See [Buildspec syntax for AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) for more information on how this file works.
35 |
36 | ## Setting up the lanes
37 |
38 | Here's an example of a `Fastfile` with a lane that runs _match_, builds the app, and uploads to TestFlight:
39 |
40 | ```ruby
41 | platform :ios do
42 | lane :beta do
43 | setup_ci
44 | match(type: 'appstore')
45 | build_app
46 | upload_to_testflight(skip_waiting_for_build_processing: true)
47 | end
48 | end
49 | ```
50 |
51 | Note the usage of `setup_ci`: it creates a temporary keychain. Without this, the build could freeze and never finish.
52 |
--------------------------------------------------------------------------------
/docs/best-practices/continuous-integration/github.md:
--------------------------------------------------------------------------------
1 | # GitHub Actions Integration
2 |
3 | Use [GitHub Actions runner](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners) running on a macOS machine to build using _fastlane_.
4 |
5 | ## Repository setup
6 |
7 | First create a `Gemfile` in the root of your project with the following content:
8 |
9 | ```ruby
10 | source 'https://rubygems.org'
11 |
12 | gem 'fastlane'
13 | ```
14 |
15 | Add a workflow yaml file to your repository. For example, if naming your workflow "build-ios-app", add `.github/workflows/build-ios-app.yml` with the following content:
16 |
17 | ```yml
18 | name: build-ios-app
19 | on:
20 | push:
21 | branches:
22 | - 'master'
23 | jobs:
24 | build:
25 | runs-on: macos-latest
26 | steps:
27 | - uses: actions/checkout@v2
28 | - run: fastlane beta
29 | env:
30 | MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
31 | ```
32 |
33 | See [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions) for more information on how this file works.
34 |
35 | ## Setting up the lanes
36 |
37 | Here's an example of a `Fastfile` with a lane that runs _match_, builds the app, and uploads to TestFlight:
38 |
39 | ```ruby
40 | platform :ios do
41 | lane :beta do
42 | setup_ci if ENV['CI']
43 | match(type: 'appstore')
44 | build_app
45 | upload_to_testflight(skip_waiting_for_build_processing: true)
46 | end
47 | end
48 | ```
49 |
50 | Note the usage of `setup_ci`: it creates a temporary keychain. Without this, the build could freeze and never finish.
51 |
--------------------------------------------------------------------------------
/docs/best-practices/continuous-integration/gitlab.md:
--------------------------------------------------------------------------------
1 | # GitLab CI Integration
2 |
3 | Use [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) running on a macOS machine
4 | to build using fastlane.
5 |
6 | ## Repository setup
7 |
8 | First create a `Gemfile` in the root of your project with the following content:
9 |
10 | ```ruby
11 | source "https://rubygems.org"
12 |
13 | gem "fastlane"
14 | ```
15 |
16 | Add a `.gitlab-ci.yml` file to trigger _fastlane_.
17 |
18 | ```yml
19 | stages:
20 | - unit_tests
21 | - test_flight
22 |
23 | variables:
24 | LC_ALL: "en_US.UTF-8"
25 | LANG: "en_US.UTF-8"
26 |
27 | before_script:
28 | - gem install bundler
29 | - bundle install
30 |
31 | unit_tests:
32 | dependencies: []
33 | stage: unit_tests
34 | artifacts:
35 | paths:
36 | - fastlane/screenshots
37 | - fastlane/logs
38 | script:
39 | - fastlane tests
40 | tags:
41 | - ios
42 |
43 | test_flight_build:
44 | dependencies: []
45 | stage: test_flight
46 | artifacts:
47 | paths:
48 | - fastlane/screenshots
49 | - fastlane/logs
50 | script:
51 | - fastlane beta
52 | tags:
53 | - ios
54 | only:
55 | - /^release-.*$/
56 | - master
57 | ```
58 |
59 | See [the `.gitlab-ci.yml` documentation](https://docs.gitlab.com/ce/ci/yaml/README.html)
60 | for more information on how this file works.
61 |
62 | ## Setting up the lanes
63 | You should have a lane - in this example called `beta` - which should do the usual, _match_, _gym_, _pilot_, to distribute an updated Test Flight version, and one lane `tests` which calls _scan_ to run UI Tests.
64 |
65 | ## Auto-incremented build number.
66 | To get an auto-incremented build number you can use something like the following lane:
67 |
68 | ```ruby
69 | lane :increment_build_number do
70 | increment_build_number(build_number: ENV['CI_JOB_ID'])
71 | end
72 | ```
73 |
74 | Then the GitLab CI job ID (which iterates on each build) will be used.
75 |
--------------------------------------------------------------------------------
/docs/best-practices/continuous-integration/travis.md:
--------------------------------------------------------------------------------
1 | # Travis Integration
2 |
3 | Update your `.travis.yml` to look like this:
4 |
5 | ```yml
6 | os: osx
7 | language: objective-c
8 | osx_image: xcode8.3
9 | install:
10 | - bundle install
11 | script:
12 | - fastlane beta
13 | ```
14 |
15 | The above config files assume you have a `Gemfile` set up, if you don't have one yet, make sure to follow our [Gemfile guide](https://docs.fastlane.tools/getting-started/ios/setup/#use-a-gemfile) and run `bundle update` to make sure you're using the most recent _fastlane_ release.
16 |
17 | Replace `beta` with the lane you want to run for your setup. If you want to build, sign and distribute builds from Travis, you'll need to add one more action to your `Fastfile`, as by default, the Travis keychain is locked.
18 |
19 | At the top of your `Fastfile`, add
20 |
21 | ```ruby
22 | setup_travis
23 | ```
24 |
25 | which will setup the keychain to work well with _match_ and _gym_. This action will also enable the `readonly` mode for _match_, so your CI doesn't create new certificates or provisioning profiles.
26 |
--------------------------------------------------------------------------------
/docs/best-practices/source-control.md:
--------------------------------------------------------------------------------
1 | ## Source Control
2 |
3 | It is recommended that you keep _fastlane_ configuration files in the repository. You may want to add the following lines to the repository's `.gitignore` (Git) or `.hgignore` (Mercurial) file to exclude generated and temporary files:
4 |
5 | ```no-highlight
6 | # fastlane specific
7 | **/fastlane/report.xml
8 |
9 | # deliver temporary files
10 | **/fastlane/Preview.html
11 |
12 | # snapshot generated screenshots
13 | **/fastlane/screenshots
14 |
15 | # scan temporary files
16 | **/fastlane/test_output
17 | ```
18 |
19 | It is also recommended that you avoid storing screenshots or other delivery artifacts in the repository. Instead, use _fastlane_ to re-generate whenever needed.
20 |
--------------------------------------------------------------------------------
/docs/create-action.md:
--------------------------------------------------------------------------------
1 | # Local actions
2 |
3 | You can create your own actions to extend the functionality of fastlane for your project. The action you create will behave exactly like the built in actions.
4 |
5 | Just run `fastlane new_action`, enter the name of the action and edit the generated Ruby file in `fastlane/actions/[action_name].rb`. After you finished writing your action, add it to your version control, so it is available for your whole team.
6 |
7 | From then on, you can just use your action in your `Fastfile`, just like any other action.
8 |
9 | ## Submitting the action to the fastlane main repo
10 |
11 | Please be aware we may not accept all actions submitted to be bundled with _fastlane_. Before you submit a pull request adding the action to the _fastlane_ code base, submit an issue proposing the new action and why it should be built-in.
12 |
13 | In general we tend to accept actions that
14 |
15 | - Generally usable for a big majority of developers (e.g. basic interactions with git)
16 | - Solve pain points for mobile app developers (iOS and Android)
17 | - have an easy to read documentation and great test coverage
18 |
19 | In general, we might not accept actions that
20 |
21 | - Solve specific use-cases for only a small subset of developers
22 | - Access the API of a third party service, the third party service should own and maintain the action
23 | - Complex actions, that will require a lot of work to maintain in the future
24 | - Everything that isn't mobile developer related
25 |
--------------------------------------------------------------------------------
/docs/css/breadcrumbs.css:
--------------------------------------------------------------------------------
1 | .wy-breadcrumbs li {
2 | display: inline-block;
3 | }
4 |
5 | .wy-breadcrumbs li.wy-breadcrumbs-aside {
6 | float: right;
7 | padding-left: 20px;
8 | }
9 |
10 | .wy-breadcrumbs li.wy-breadcrumbs-aside input {
11 | width: 250px;
12 | }
13 |
14 | .wy-breadcrumbs li a {
15 | display: inline-block;
16 | padding: 5px;
17 | }
18 |
19 | .wy-breadcrumbs li a:first-child {
20 | padding-left: 0;
21 | }
22 |
23 | .wy-breadcrumbs-extra {
24 | margin-bottom: 0;
25 | color: #b3b3b3;
26 | font-size: 80%;
27 | display: inline-block;
28 | }
29 |
30 | .wy-breadcrumbs input[type=text] {
31 | width: 100%;
32 | color: #333;
33 | border-radius: 3px;
34 | outline: 0;
35 | padding: 10px;
36 | height: 30px;
37 | background-color: #fff;
38 | border: solid 1px #6d6d6d;
39 | box-shadow: none
40 | }
41 |
42 | /*
43 | .wy-breadcrumbs-aside {
44 | padding-left: 10px;
45 | }
46 | */
47 |
48 | @media screen and (max-width: 768px) {
49 | .wy-breadcrumbs-extra {
50 | display: none;
51 | }
52 |
53 | .wy-breadcrumbs li.wy-breadcrumbs-aside {
54 | display: none;
55 | }
56 |
57 | .wy-breadcrumbs-extra-search,
58 | .wy-breadcrumbs li.wy-breadcrumbs-aside-search {
59 | display: block;
60 | padding-left: 0px;
61 | }
62 |
63 | .algolia-autocomplete .ds-dropdown-menu {
64 | max-width: 80vh !important;
65 | min-width: 250px !important;
66 | }
67 | }
68 |
69 | .algolia-autocomplete .ds-dropdown-menu {
70 | z-index: 10000 !important;
71 | }
72 |
73 | @media print {
74 | .wy-breadcrumbs li.wy-breadcrumbs-aside {
75 | display: none;
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/docs/generated/actions/adb.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # adb
7 |
8 |
9 | Run ADB Actions
10 |
11 |
12 |
13 |
14 | > see adb --help for more details
15 |
16 |
17 | adb ||
18 | ---|---
19 | Supported platforms | android
20 | Author | @hjanuschka
21 | Returns | The output of the adb command
22 |
23 |
24 |
25 | ## 1 Example
26 |
27 | ```ruby
28 | adb(
29 | command: "shell ls"
30 | )
31 | ```
32 |
33 |
34 |
35 |
36 |
37 | ## Parameters
38 |
39 | Key | Description | Default
40 | ----|-------------|--------
41 | `serial` | Android serial of the device to use for this command | `''`
42 | `command` | All commands you want to pass to the adb command, e.g. `kill-server` |
43 | `adb_path` | The path to your `adb` binary (can be left blank if the ANDROID_SDK_ROOT, ANDROID_HOME or ANDROID_SDK environment variable is set) | `adb`
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action adb
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run adb
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run adb parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/adb_devices.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # adb_devices
7 |
8 |
9 | Get an array of Connected android device serials
10 |
11 |
12 |
13 |
14 | > Fetches device list via adb, e.g. run an adb command on all connected devices.
15 |
16 |
17 | adb_devices ||
18 | ---|---
19 | Supported platforms | android
20 | Author | @hjanuschka
21 | Returns | Returns an array of all currently connected android devices
22 |
23 |
24 |
25 | ## 1 Example
26 |
27 | ```ruby
28 | adb_devices.each do |device|
29 | model = adb(command: "shell getprop ro.product.model",
30 | serial: device.serial).strip
31 |
32 | puts "Model #{model} is connected"
33 | end
34 | ```
35 |
36 |
37 |
38 |
39 |
40 | ## Parameters
41 |
42 | Key | Description | Default
43 | ----|-------------|--------
44 | `adb_path` | The path to your `adb` binary (can be left blank if the ANDROID_SDK_ROOT environment variable is set) | `adb`
45 |
46 | * = default value is dependent on the user's system
47 |
48 |
49 |
50 |
51 |
52 |
53 | ## Documentation
54 |
55 | To show the documentation in your terminal, run
56 | ```no-highlight
57 | fastlane action adb_devices
58 | ```
59 |
60 |
61 |
62 | ## CLI
63 |
64 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
65 |
66 | ```no-highlight
67 | fastlane run adb_devices
68 | ```
69 |
70 | To pass parameters, make use of the `:` symbol, for example
71 |
72 | ```no-highlight
73 | fastlane run adb_devices parameter1:"value1" parameter2:"value2"
74 | ```
75 |
76 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
77 |
78 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
79 |
80 |
81 |
82 | ## Source code
83 |
84 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
85 |
86 |
87 |
88 | Back to actions
89 |
--------------------------------------------------------------------------------
/docs/generated/actions/add_extra_platforms.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # add_extra_platforms
7 |
8 |
9 | Modify the default list of supported platforms
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | add_extra_platforms ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @lacostej
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | add_extra_platforms(
28 | platforms: [:windows, :neogeo]
29 | )
30 | ```
31 |
32 |
33 |
34 |
35 |
36 | ## Parameters
37 |
38 | Key | Description | Default
39 | ----|-------------|--------
40 | `platforms` | The optional extra platforms to support | `''`
41 |
42 | * = default value is dependent on the user's system
43 |
44 |
45 |
46 |
47 |
48 |
49 | ## Documentation
50 |
51 | To show the documentation in your terminal, run
52 | ```no-highlight
53 | fastlane action add_extra_platforms
54 | ```
55 |
56 |
57 |
58 | ## CLI
59 |
60 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
61 |
62 | ```no-highlight
63 | fastlane run add_extra_platforms
64 | ```
65 |
66 | To pass parameters, make use of the `:` symbol, for example
67 |
68 | ```no-highlight
69 | fastlane run add_extra_platforms parameter1:"value1" parameter2:"value2"
70 | ```
71 |
72 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
73 |
74 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
75 |
76 |
77 |
78 | ## Source code
79 |
80 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
81 |
82 |
83 |
84 | Back to actions
85 |
--------------------------------------------------------------------------------
/docs/generated/actions/apteligent.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # apteligent
7 |
8 |
9 | Upload dSYM file to [Apteligent (Crittercism)](http://www.apteligent.com/)
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | apteligent ||
18 | ---|---
19 | Supported platforms | ios
20 | Author | @Mo7amedFouad
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | apteligent(
28 | app_id: "...",
29 | api_key: "..."
30 | )
31 | ```
32 |
33 |
34 |
35 |
36 |
37 | ## Parameters
38 |
39 | Key | Description | Default
40 | ----|-------------|--------
41 | `dsym` | dSYM.zip file to upload to Apteligent |
42 | `app_id` | Apteligent App ID key e.g. 569f5c87cb99e10e00c7xxxx |
43 | `api_key` | Apteligent App API key e.g. IXPQIi8yCbHaLliqzRoo065tH0lxxxxx |
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action apteligent
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run apteligent
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run apteligent parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/backup_file.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # backup_file
7 |
8 |
9 | This action backs up your file to "[path].back"
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | backup_file ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @gin0606
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | backup_file(path: "/path/to/file")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `path` | Path to the file you want to backup |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action backup_file
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run backup_file
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run backup_file parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/chatwork.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # chatwork
7 |
8 |
9 | Send a success/error message to [ChatWork](https://go.chatwork.com/)
10 |
11 |
12 |
13 |
14 | > Information on how to obtain an API token: [http://developer.chatwork.com/ja/authenticate.html](http://developer.chatwork.com/ja/authenticate.html)
15 |
16 |
17 | chatwork ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @astronaughts
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | chatwork(
28 | message: "App successfully released!",
29 | roomid: 12345,
30 | success: true,
31 | api_token: "Your Token"
32 | )
33 | ```
34 |
35 |
36 |
37 |
38 |
39 | ## Parameters
40 |
41 | Key | Description | Default
42 | ----|-------------|--------
43 | `api_token` | ChatWork API Token |
44 | `message` | The message to post on ChatWork |
45 | `roomid` | The room ID |
46 | `success` | Was this build successful? (true/false) | `true`
47 |
48 | * = default value is dependent on the user's system
49 |
50 |
51 |
52 |
53 |
54 |
55 | ## Documentation
56 |
57 | To show the documentation in your terminal, run
58 | ```no-highlight
59 | fastlane action chatwork
60 | ```
61 |
62 |
63 |
64 | ## CLI
65 |
66 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
67 |
68 | ```no-highlight
69 | fastlane run chatwork
70 | ```
71 |
72 | To pass parameters, make use of the `:` symbol, for example
73 |
74 | ```no-highlight
75 | fastlane run chatwork parameter1:"value1" parameter2:"value2"
76 | ```
77 |
78 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
79 |
80 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
81 |
82 |
83 |
84 | ## Source code
85 |
86 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
87 |
88 |
89 |
90 | Back to actions
91 |
--------------------------------------------------------------------------------
/docs/generated/actions/clean_cocoapods_cache.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # clean_cocoapods_cache
7 |
8 |
9 | Remove the cache for pods
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | clean_cocoapods_cache ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @alexmx
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | clean_cocoapods_cache
28 | ```
29 |
30 | ```ruby
31 | clean_cocoapods_cache(name: "CACHED_POD")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `name` | Pod name to be removed from cache |
43 | `no_ansi` | Show output without ANSI codes | `false`
44 | `verbose` | Show more debugging information | `false`
45 | `silent` | Show nothing | `false`
46 | `allow_root` | Allows CocoaPods to run as root | `false`
47 |
48 | * = default value is dependent on the user's system
49 |
50 |
51 |
52 |
53 |
54 |
55 | ## Documentation
56 |
57 | To show the documentation in your terminal, run
58 | ```no-highlight
59 | fastlane action clean_cocoapods_cache
60 | ```
61 |
62 |
63 |
64 | ## CLI
65 |
66 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
67 |
68 | ```no-highlight
69 | fastlane run clean_cocoapods_cache
70 | ```
71 |
72 | To pass parameters, make use of the `:` symbol, for example
73 |
74 | ```no-highlight
75 | fastlane run clean_cocoapods_cache parameter1:"value1" parameter2:"value2"
76 | ```
77 |
78 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
79 |
80 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
81 |
82 |
83 |
84 | ## Source code
85 |
86 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
87 |
88 |
89 |
90 | Back to actions
91 |
--------------------------------------------------------------------------------
/docs/generated/actions/clear_derived_data.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # clear_derived_data
7 |
8 |
9 | Deletes the Xcode Derived Data
10 |
11 |
12 |
13 |
14 | > Deletes the Derived Data from path set on Xcode or a supplied path
15 |
16 |
17 | clear_derived_data ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | clear_derived_data
28 | ```
29 |
30 | ```ruby
31 | clear_derived_data(derived_data_path: "/custom/")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `derived_data_path` | Custom path for derivedData | [*](#parameters-legend-dynamic)
43 |
44 | * = default value is dependent on the user's system
45 |
46 |
47 |
48 |
49 |
50 |
51 | ## Documentation
52 |
53 | To show the documentation in your terminal, run
54 | ```no-highlight
55 | fastlane action clear_derived_data
56 | ```
57 |
58 |
59 |
60 | ## CLI
61 |
62 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
63 |
64 | ```no-highlight
65 | fastlane run clear_derived_data
66 | ```
67 |
68 | To pass parameters, make use of the `:` symbol, for example
69 |
70 | ```no-highlight
71 | fastlane run clear_derived_data parameter1:"value1" parameter2:"value2"
72 | ```
73 |
74 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
75 |
76 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
77 |
78 |
79 |
80 | ## Source code
81 |
82 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
83 |
84 |
85 |
86 | Back to actions
87 |
--------------------------------------------------------------------------------
/docs/generated/actions/clipboard.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # clipboard
7 |
8 |
9 | Copies a given string into the clipboard. Works only on macOS
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | clipboard ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx, @joshdholtz, @rogerluan
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | clipboard(value: "https://docs.fastlane.tools/")
28 | ```
29 |
30 | ```ruby
31 | clipboard(value: lane_context[SharedValues::HOCKEY_DOWNLOAD_LINK] || "")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `value` | The string that should be copied into the clipboard |
43 |
44 | * = default value is dependent on the user's system
45 |
46 |
47 |
48 |
49 |
50 |
51 | ## Documentation
52 |
53 | To show the documentation in your terminal, run
54 | ```no-highlight
55 | fastlane action clipboard
56 | ```
57 |
58 |
59 |
60 | ## CLI
61 |
62 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
63 |
64 | ```no-highlight
65 | fastlane run clipboard
66 | ```
67 |
68 | To pass parameters, make use of the `:` symbol, for example
69 |
70 | ```no-highlight
71 | fastlane run clipboard parameter1:"value1" parameter2:"value2"
72 | ```
73 |
74 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
75 |
76 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
77 |
78 |
79 |
80 | ## Source code
81 |
82 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
83 |
84 |
85 |
86 | Back to actions
87 |
--------------------------------------------------------------------------------
/docs/generated/actions/clubmate.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # clubmate
7 |
8 |
9 | Print a Club Mate in your build output
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | clubmate |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 |
25 |
26 |
27 | To show the documentation in your terminal, run
28 | ```no-highlight
29 | fastlane action clubmate
30 | ```
31 |
32 | View source code
33 |
34 |
35 |
36 | Back to actions
37 |
--------------------------------------------------------------------------------
/docs/generated/actions/debug.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # debug
7 |
8 |
9 | Print out an overview of the lane context values
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | debug ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | debug
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action debug
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run debug
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run debug parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/default_platform.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # default_platform
7 |
8 |
9 | Defines a default platform to not have to specify the platform
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | default_platform ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | default_platform(:android)
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Lane Variables
39 |
40 | Actions can communicate with each other using a shared hash `lane_context`, that can be accessed in other actions, plugins or your lanes: `lane_context[SharedValues:XYZ]`. The `default_platform` action generates the following Lane Variables:
41 |
42 | SharedValue | Description
43 | ------------|-------------
44 | `SharedValues::DEFAULT_PLATFORM` | The default platform
45 |
46 | To get more information check the [Lanes documentation](https://docs.fastlane.tools/advanced/lanes/#lane-context).
47 |
48 |
49 |
50 | ## Documentation
51 |
52 | To show the documentation in your terminal, run
53 | ```no-highlight
54 | fastlane action default_platform
55 | ```
56 |
57 |
58 |
59 | ## CLI
60 |
61 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
62 |
63 | ```no-highlight
64 | fastlane run default_platform
65 | ```
66 |
67 | To pass parameters, make use of the `:` symbol, for example
68 |
69 | ```no-highlight
70 | fastlane run default_platform parameter1:"value1" parameter2:"value2"
71 | ```
72 |
73 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
74 |
75 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
76 |
77 |
78 |
79 | ## Source code
80 |
81 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
82 |
83 |
84 |
85 | Back to actions
86 |
--------------------------------------------------------------------------------
/docs/generated/actions/delete_keychain.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # delete_keychain
7 |
8 |
9 | Delete keychains and remove them from the search list
10 |
11 |
12 |
13 |
14 | > Keychains can be deleted after being created with `create_keychain`
15 |
16 |
17 | delete_keychain ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @gin0606, @koenpunt
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | delete_keychain(name: "KeychainName")
28 | ```
29 |
30 | ```ruby
31 | delete_keychain(keychain_path: "/keychains/project.keychain")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `name` | Keychain name |
43 | `keychain_path` | Keychain path |
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action delete_keychain
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run delete_keychain
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run delete_keychain parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/dotgpg_environment.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # dotgpg_environment
7 |
8 |
9 | Reads in production secrets set in a dotgpg file and puts them in ENV
10 |
11 |
12 |
13 |
14 | > More information about dotgpg can be found at [https://github.com/ConradIrwin/dotgpg](https://github.com/ConradIrwin/dotgpg).
15 |
16 |
17 | dotgpg_environment ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @simonlevy5
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | dotgpg_environment(dotgpg_file: './path/to/gpgfile')
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `dotgpg_file` | Path to your gpg file | [*](#parameters-legend-dynamic)
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action dotgpg_environment
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run dotgpg_environment
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run dotgpg_environment parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/echo.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # echo
7 |
8 |
9 | Alias for the `puts` action
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | echo ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | puts "Hi there"
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `message` | Message to be printed out |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action echo
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run echo
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run echo parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/ensure_bundle_exec.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # ensure_bundle_exec
7 |
8 |
9 | Raises an exception if not using `bundle exec` to run fastlane
10 |
11 |
12 |
13 |
14 | > This action will check if you are using `bundle exec` to run fastlane.
You can put it into `before_all` to make sure that fastlane is ran using the `bundle exec fastlane` command.
15 |
16 |
17 | ensure_bundle_exec ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @rishabhtayal
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | ensure_bundle_exec
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action ensure_bundle_exec
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run ensure_bundle_exec
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run ensure_bundle_exec parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/ensure_env_vars.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # ensure_env_vars
7 |
8 |
9 | Raises an exception if the specified env vars are not set
10 |
11 |
12 |
13 |
14 | > This action will check if some environment variables are set.
15 |
16 |
17 | ensure_env_vars ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @revolter
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | ensure_env_vars(
28 | env_vars: ['GITHUB_USER_NAME', 'GITHUB_API_TOKEN']
29 | )
30 | ```
31 |
32 |
33 |
34 |
35 |
36 | ## Parameters
37 |
38 | Key | Description | Default
39 | ----|-------------|--------
40 | `env_vars` | The environment variables names that should be checked |
41 |
42 | * = default value is dependent on the user's system
43 |
44 |
45 |
46 |
47 |
48 |
49 | ## Documentation
50 |
51 | To show the documentation in your terminal, run
52 | ```no-highlight
53 | fastlane action ensure_env_vars
54 | ```
55 |
56 |
57 |
58 | ## CLI
59 |
60 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
61 |
62 | ```no-highlight
63 | fastlane run ensure_env_vars
64 | ```
65 |
66 | To pass parameters, make use of the `:` symbol, for example
67 |
68 | ```no-highlight
69 | fastlane run ensure_env_vars parameter1:"value1" parameter2:"value2"
70 | ```
71 |
72 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
73 |
74 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
75 |
76 |
77 |
78 | ## Source code
79 |
80 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
81 |
82 |
83 |
84 | Back to actions
85 |
--------------------------------------------------------------------------------
/docs/generated/actions/environment_variable.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # environment_variable
7 |
8 |
9 | Sets/gets env vars for Fastlane.swift. Don't use in ruby, use `ENV[key] = val`
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | environment_variable ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @taquitos
21 |
22 |
23 |
24 |
25 |
26 | ## Parameters
27 |
28 | Key | Description | Default
29 | ----|-------------|--------
30 | `set` | Set the environment variables named |
31 | `get` | Get the environment variable named |
32 | `remove` | Remove the environment variable named |
33 |
34 | * = default value is dependent on the user's system
35 |
36 |
37 |
38 |
39 |
40 |
41 | ## Documentation
42 |
43 | To show the documentation in your terminal, run
44 | ```no-highlight
45 | fastlane action environment_variable
46 | ```
47 |
48 |
49 |
50 | ## CLI
51 |
52 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
53 |
54 | ```no-highlight
55 | fastlane run environment_variable
56 | ```
57 |
58 | To pass parameters, make use of the `:` symbol, for example
59 |
60 | ```no-highlight
61 | fastlane run environment_variable parameter1:"value1" parameter2:"value2"
62 | ```
63 |
64 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
65 |
66 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
67 |
68 |
69 |
70 | ## Source code
71 |
72 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
73 |
74 |
75 |
76 | Back to actions
77 |
--------------------------------------------------------------------------------
/docs/generated/actions/fastlane_version.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # fastlane_version
7 |
8 |
9 | Alias for the `min_fastlane_version` action
10 |
11 |
12 |
13 |
14 | > Add this to your `Fastfile` to require a certain version of _fastlane_.
Use it if you use an action that just recently came out and you need it.
15 |
16 |
17 | fastlane_version ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | min_fastlane_version("1.50.0")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action fastlane_version
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run fastlane_version
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run fastlane_version parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/flock.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # flock
7 |
8 |
9 | Send a message to a [Flock](https://flock.com/) group
10 |
11 |
12 |
13 |
14 | > To obtain the token, create a new [incoming message webhook](https://dev.flock.co/wiki/display/FlockAPI/Incoming+Webhooks) in your Flock admin panel.
15 |
16 |
17 | flock ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @Manav
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | flock(
28 | message: "Hello",
29 | token: "xxx"
30 | )
31 | ```
32 |
33 |
34 |
35 |
36 |
37 | ## Parameters
38 |
39 | Key | Description | Default
40 | ----|-------------|--------
41 | `message` | Message text |
42 | `token` | Token for the Flock incoming webhook |
43 | `base_url` | Base URL of the Flock incoming message webhook | `https://api.flock.co/hooks/sendMessage`
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action flock
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run flock
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run flock parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/gcovr.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # gcovr
7 |
8 |
9 | Runs test coverage reports for your Xcode project
10 |
11 |
12 |
13 |
14 | > Generate summarized code coverage reports using [gcovr](http://gcovr.com/)
15 |
16 |
17 | gcovr ||
18 | ---|---
19 | Supported platforms | ios
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | gcovr(
28 | html: true,
29 | html_details: true,
30 | output: "./code-coverage/report.html"
31 | )
32 | ```
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 | ## Documentation
43 |
44 | To show the documentation in your terminal, run
45 | ```no-highlight
46 | fastlane action gcovr
47 | ```
48 |
49 |
50 |
51 | ## CLI
52 |
53 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
54 |
55 | ```no-highlight
56 | fastlane run gcovr
57 | ```
58 |
59 | To pass parameters, make use of the `:` symbol, for example
60 |
61 | ```no-highlight
62 | fastlane run gcovr parameter1:"value1" parameter2:"value2"
63 | ```
64 |
65 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
66 |
67 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
68 |
69 |
70 |
71 | ## Source code
72 |
73 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
74 |
75 |
76 |
77 | Back to actions
78 |
--------------------------------------------------------------------------------
/docs/generated/actions/git_pull.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # git_pull
7 |
8 |
9 | Executes a simple git pull command
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | git_pull ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx, @JaviSoto
21 |
22 |
23 |
24 | ## 3 Examples
25 |
26 | ```ruby
27 | git_pull
28 | ```
29 |
30 | ```ruby
31 | git_pull(only_tags: true) # only the tags, no commits
32 | ```
33 |
34 | ```ruby
35 | git_pull(rebase: true) # use --rebase with pull
36 | ```
37 |
38 |
39 |
40 |
41 |
42 | ## Parameters
43 |
44 | Key | Description | Default
45 | ----|-------------|--------
46 | `only_tags` | Simply pull the tags, and not bring new commits to the current branch from the remote | `false`
47 | `rebase` | Rebase on top of the remote branch instead of merge | `false`
48 |
49 | * = default value is dependent on the user's system
50 |
51 |
52 |
53 |
54 |
55 |
56 | ## Documentation
57 |
58 | To show the documentation in your terminal, run
59 | ```no-highlight
60 | fastlane action git_pull
61 | ```
62 |
63 |
64 |
65 | ## CLI
66 |
67 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
68 |
69 | ```no-highlight
70 | fastlane run git_pull
71 | ```
72 |
73 | To pass parameters, make use of the `:` symbol, for example
74 |
75 | ```no-highlight
76 | fastlane run git_pull parameter1:"value1" parameter2:"value2"
77 | ```
78 |
79 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
80 |
81 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
82 |
83 |
84 |
85 | ## Source code
86 |
87 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
88 |
89 |
90 |
91 | Back to actions
92 |
--------------------------------------------------------------------------------
/docs/generated/actions/git_remote_branch.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # git_remote_branch
7 |
8 |
9 | Returns the name of the current git remote default branch
10 |
11 |
12 |
13 |
14 | > If no default remote branch could be found, this action will return nil. This is a wrapper for the internal action Actions.git_default_remote_branch_name
15 |
16 |
17 | git_remote_branch ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @SeanMcNeil
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | git_remote_branch # Query git for first available remote name
28 | ```
29 |
30 | ```ruby
31 | git_remote_branch(remote_name:"upstream") # Provide a remote name
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `remote_name` | The remote repository to check |
43 |
44 | * = default value is dependent on the user's system
45 |
46 |
47 |
48 |
49 |
50 |
51 | ## Documentation
52 |
53 | To show the documentation in your terminal, run
54 | ```no-highlight
55 | fastlane action git_remote_branch
56 | ```
57 |
58 |
59 |
60 | ## CLI
61 |
62 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
63 |
64 | ```no-highlight
65 | fastlane run git_remote_branch
66 | ```
67 |
68 | To pass parameters, make use of the `:` symbol, for example
69 |
70 | ```no-highlight
71 | fastlane run git_remote_branch parameter1:"value1" parameter2:"value2"
72 | ```
73 |
74 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
75 |
76 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
77 |
78 |
79 |
80 | ## Source code
81 |
82 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
83 |
84 |
85 |
86 | Back to actions
87 |
--------------------------------------------------------------------------------
/docs/generated/actions/git_submodule_update.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # git_submodule_update
7 |
8 |
9 | Executes a git submodule update command
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | git_submodule_update ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @braunico
21 |
22 |
23 |
24 | ## 4 Examples
25 |
26 | ```ruby
27 | git_submodule_update
28 | ```
29 |
30 | ```ruby
31 | git_submodule_update(recursive: true)
32 | ```
33 |
34 | ```ruby
35 | git_submodule_update(init: true)
36 | ```
37 |
38 | ```ruby
39 | git_submodule_update(recursive: true, init: true)
40 | ```
41 |
42 |
43 |
44 |
45 |
46 | ## Parameters
47 |
48 | Key | Description | Default
49 | ----|-------------|--------
50 | `recursive` | Should the submodules be updated recursively? | `false`
51 | `init` | Should the submodules be initiated before update? | `false`
52 |
53 | * = default value is dependent on the user's system
54 |
55 |
56 |
57 |
58 |
59 |
60 | ## Documentation
61 |
62 | To show the documentation in your terminal, run
63 | ```no-highlight
64 | fastlane action git_submodule_update
65 | ```
66 |
67 |
68 |
69 | ## CLI
70 |
71 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
72 |
73 | ```no-highlight
74 | fastlane run git_submodule_update
75 | ```
76 |
77 | To pass parameters, make use of the `:` symbol, for example
78 |
79 | ```no-highlight
80 | fastlane run git_submodule_update parameter1:"value1" parameter2:"value2"
81 | ```
82 |
83 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
84 |
85 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
86 |
87 |
88 |
89 | ## Source code
90 |
91 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
92 |
93 |
94 |
95 | Back to actions
96 |
--------------------------------------------------------------------------------
/docs/generated/actions/git_tag_exists.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # git_tag_exists
7 |
8 |
9 | Checks if the git tag with the given name exists in the current repo
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | git_tag_exists ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @antondomashnev
21 | Returns | Boolean value whether the tag exists or not
22 |
23 |
24 |
25 | ## 1 Example
26 |
27 | ```ruby
28 | if git_tag_exists(tag: "1.1.0")
29 | UI.message("Found it 🚀")
30 | end
31 | ```
32 |
33 |
34 |
35 |
36 |
37 | ## Parameters
38 |
39 | Key | Description | Default
40 | ----|-------------|--------
41 | `tag` | The tag name that should be checked |
42 | `remote` | Whether to check remote. Defaults to `false` | `false`
43 | `remote_name` | The remote to check. Defaults to `origin` | `origin`
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action git_tag_exists
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run git_tag_exists
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run git_tag_exists parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/hg_add_tag.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # hg_add_tag
7 |
8 |
9 | This will add a hg tag to the current branch
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | hg_add_tag ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @sjrmanning
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | hg_add_tag(tag: "1.3")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `tag` | Tag to create |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action hg_add_tag
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run hg_add_tag
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run hg_add_tag parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/hg_push.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # hg_push
7 |
8 |
9 | This will push changes to the remote hg repository
10 |
11 |
12 |
13 |
14 | > The mercurial equivalent of [push_to_git_remote](https://docs.fastlane.tools/actions/push_to_git_remote/). Pushes your local commits to a remote mercurial repo. Useful when local changes such as adding a version bump commit or adding a tag are part of your lane’s actions.
15 |
16 |
17 | hg_push ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @sjrmanning
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | hg_push
28 | ```
29 |
30 | ```ruby
31 | hg_push(
32 | destination: "ssh://hg@repohost.com/owner/repo",
33 | force: true
34 | )
35 | ```
36 |
37 |
38 |
39 |
40 |
41 | ## Parameters
42 |
43 | Key | Description | Default
44 | ----|-------------|--------
45 | `force` | Force push to remote | `false`
46 | `destination` | The destination to push to | `''`
47 |
48 | * = default value is dependent on the user's system
49 |
50 |
51 |
52 |
53 |
54 |
55 | ## Documentation
56 |
57 | To show the documentation in your terminal, run
58 | ```no-highlight
59 | fastlane action hg_push
60 | ```
61 |
62 |
63 |
64 | ## CLI
65 |
66 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
67 |
68 | ```no-highlight
69 | fastlane run hg_push
70 | ```
71 |
72 | To pass parameters, make use of the `:` symbol, for example
73 |
74 | ```no-highlight
75 | fastlane run hg_push parameter1:"value1" parameter2:"value2"
76 | ```
77 |
78 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
79 |
80 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
81 |
82 |
83 |
84 | ## Source code
85 |
86 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
87 |
88 |
89 |
90 | Back to actions
91 |
--------------------------------------------------------------------------------
/docs/generated/actions/import.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # import
7 |
8 |
9 | Import another Fastfile to use its lanes
10 |
11 |
12 |
13 |
14 | > This is useful if you have shared lanes across multiple apps and you want to store a Fastfile in a separate folder.
The path must be relative to the Fastfile this is called from.
15 |
16 |
17 | import ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | import("./path/to/other/Fastfile")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action import
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run import
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run import parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/install_provisioning_profile.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # install_provisioning_profile
7 |
8 |
9 | Install provisioning profile from path
10 |
11 |
12 |
13 |
14 | > Install provisioning profile from path for current user
15 |
16 |
17 | install_provisioning_profile ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @SofteqDG
21 | Returns | The absolute path to the installed provisioning profile
22 |
23 |
24 |
25 | ## 1 Example
26 |
27 | ```ruby
28 | install_provisioning_profile(path: "profiles/profile.mobileprovision")
29 | ```
30 |
31 |
32 |
33 |
34 |
35 | ## Parameters
36 |
37 | Key | Description | Default
38 | ----|-------------|--------
39 | `path` | Path to provisioning profile |
40 |
41 | * = default value is dependent on the user's system
42 |
43 |
44 |
45 |
46 |
47 |
48 | ## Documentation
49 |
50 | To show the documentation in your terminal, run
51 | ```no-highlight
52 | fastlane action install_provisioning_profile
53 | ```
54 |
55 |
56 |
57 | ## CLI
58 |
59 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
60 |
61 | ```no-highlight
62 | fastlane run install_provisioning_profile
63 | ```
64 |
65 | To pass parameters, make use of the `:` symbol, for example
66 |
67 | ```no-highlight
68 | fastlane run install_provisioning_profile parameter1:"value1" parameter2:"value2"
69 | ```
70 |
71 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
72 |
73 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
74 |
75 |
76 |
77 | ## Source code
78 |
79 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
80 |
81 |
82 |
83 | Back to actions
84 |
--------------------------------------------------------------------------------
/docs/generated/actions/install_xcode_plugin.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # install_xcode_plugin
7 |
8 |
9 | Install an Xcode plugin for the current user
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | install_xcode_plugin ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @NeoNachoSoto, @tommeier
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | install_xcode_plugin(url: "https://example.com/clubmate/plugin.zip")
28 | ```
29 |
30 | ```ruby
31 | install_xcode_plugin(github: "https://github.com/contentful/ContentfulXcodePlugin")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `url` | URL for Xcode plugin ZIP file |
43 | `github` | GitHub repository URL for Xcode plugin |
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action install_xcode_plugin
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run install_xcode_plugin
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run install_xcode_plugin parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/is_ci.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # is_ci
7 |
8 |
9 | Is the current run being executed on a CI system, like Jenkins or Travis
10 |
11 |
12 |
13 |
14 | > The return value of this method is true if fastlane is currently executed on Travis, Jenkins, Circle or a similar CI service
15 |
16 |
17 | is_ci ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | if is_ci
28 | puts "I'm a computer"
29 | else
30 | say "Hi Human!"
31 | end
32 | ```
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 | ## Documentation
43 |
44 | To show the documentation in your terminal, run
45 | ```no-highlight
46 | fastlane action is_ci
47 | ```
48 |
49 |
50 |
51 | ## CLI
52 |
53 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
54 |
55 | ```no-highlight
56 | fastlane run is_ci
57 | ```
58 |
59 | To pass parameters, make use of the `:` symbol, for example
60 |
61 | ```no-highlight
62 | fastlane run is_ci parameter1:"value1" parameter2:"value2"
63 | ```
64 |
65 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
66 |
67 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
68 |
69 |
70 |
71 | ## Source code
72 |
73 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
74 |
75 |
76 |
77 | Back to actions
78 |
--------------------------------------------------------------------------------
/docs/generated/actions/jazzy.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # jazzy
7 |
8 |
9 | Generate docs using Jazzy
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | jazzy ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | jazzy
28 | ```
29 |
30 | ```ruby
31 | jazzy(config: ".jazzy.yaml", module_version: "2.1.37")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `config` | Path to jazzy config file |
43 | `module_version` | Version string to use as part of the default docs title and inside the docset |
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action jazzy
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run jazzy
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run jazzy parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/lane_context.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # lane_context
7 |
8 |
9 | Access lane context values
10 |
11 |
12 |
13 |
14 | > Access the fastlane lane context values.
More information about how the lane context works: [https://docs.fastlane.tools/advanced/#lane-context](https://docs.fastlane.tools/advanced/#lane-context).
15 |
16 |
17 | lane_context ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | lane_context[SharedValues::BUILD_NUMBER]
28 | ```
29 |
30 | ```ruby
31 | lane_context[SharedValues::IPA_OUTPUT_PATH]
32 | ```
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 | ## Documentation
43 |
44 | To show the documentation in your terminal, run
45 | ```no-highlight
46 | fastlane action lane_context
47 | ```
48 |
49 |
50 |
51 | ## CLI
52 |
53 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
54 |
55 | ```no-highlight
56 | fastlane run lane_context
57 | ```
58 |
59 | To pass parameters, make use of the `:` symbol, for example
60 |
61 | ```no-highlight
62 | fastlane run lane_context parameter1:"value1" parameter2:"value2"
63 | ```
64 |
65 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
66 |
67 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
68 |
69 |
70 |
71 | ## Source code
72 |
73 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
74 |
75 |
76 |
77 | Back to actions
78 |
--------------------------------------------------------------------------------
/docs/generated/actions/last_git_commit.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # last_git_commit
7 |
8 |
9 | Return last git commit hash, abbreviated commit hash, commit message and author
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | last_git_commit ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @ngutman
21 | Returns | Returns the following dict: {commit_hash: "commit hash", abbreviated_commit_hash: "abbreviated commit hash" author: "Author", author_email: "author email", message: "commit message"}
22 |
23 |
24 |
25 | ## 1 Example
26 |
27 | ```ruby
28 | commit = last_git_commit
29 | pilot(changelog: commit[:message]) # message of commit
30 | author = commit[:author] # author of the commit
31 | author_email = commit[:author_email] # email of the author of the commit
32 | hash = commit[:commit_hash] # long sha of commit
33 | short_hash = commit[:abbreviated_commit_hash] # short sha of commit
34 | ```
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 | ## Documentation
45 |
46 | To show the documentation in your terminal, run
47 | ```no-highlight
48 | fastlane action last_git_commit
49 | ```
50 |
51 |
52 |
53 | ## CLI
54 |
55 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
56 |
57 | ```no-highlight
58 | fastlane run last_git_commit
59 | ```
60 |
61 | To pass parameters, make use of the `:` symbol, for example
62 |
63 | ```no-highlight
64 | fastlane run last_git_commit parameter1:"value1" parameter2:"value2"
65 | ```
66 |
67 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
68 |
69 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
70 |
71 |
72 |
73 | ## Source code
74 |
75 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
76 |
77 |
78 |
79 | Back to actions
80 |
--------------------------------------------------------------------------------
/docs/generated/actions/lcov.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # lcov
7 |
8 |
9 | Generates coverage data using lcov
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | lcov ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @thiagolioy
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | lcov(
28 | project_name: "ProjectName",
29 | scheme: "yourScheme",
30 | output_dir: "cov_reports" # This value is optional. Default is coverage_reports
31 | )
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `project_name` | Name of the project |
43 | `scheme` | Scheme of the project |
44 | `arch` | The build arch where will search .gcda files | `i386`
45 | `output_dir` | The output directory that coverage data will be stored. If not passed will use coverage_reports as default value | `coverage_reports`
46 |
47 | * = default value is dependent on the user's system
48 |
49 |
50 |
51 |
52 |
53 |
54 | ## Documentation
55 |
56 | To show the documentation in your terminal, run
57 | ```no-highlight
58 | fastlane action lcov
59 | ```
60 |
61 |
62 |
63 | ## CLI
64 |
65 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
66 |
67 | ```no-highlight
68 | fastlane run lcov
69 | ```
70 |
71 | To pass parameters, make use of the `:` symbol, for example
72 |
73 | ```no-highlight
74 | fastlane run lcov parameter1:"value1" parameter2:"value2"
75 | ```
76 |
77 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
78 |
79 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
80 |
81 |
82 |
83 | ## Source code
84 |
85 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
86 |
87 |
88 |
89 | Back to actions
90 |
--------------------------------------------------------------------------------
/docs/generated/actions/min_fastlane_version.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # min_fastlane_version
7 |
8 |
9 | Verifies the minimum fastlane version required
10 |
11 |
12 |
13 |
14 | > Add this to your `Fastfile` to require a certain version of _fastlane_.
Use it if you use an action that just recently came out and you need it.
15 |
16 |
17 | min_fastlane_version ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | min_fastlane_version("1.50.0")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action min_fastlane_version
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run min_fastlane_version
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run min_fastlane_version parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/notify.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # notify
7 |
8 |
9 | Shows a macOS notification - use `notification` instead
10 |
11 | > It's recommended to use the new `notification` action instead of `notify`
12 |
13 |
14 |
15 |
16 |
17 | notify ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @champo, @KrauseFx
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 | ## Documentation
31 |
32 | To show the documentation in your terminal, run
33 | ```no-highlight
34 | fastlane action notify
35 | ```
36 |
37 |
38 |
39 | ## CLI
40 |
41 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
42 |
43 | ```no-highlight
44 | fastlane run notify
45 | ```
46 |
47 | To pass parameters, make use of the `:` symbol, for example
48 |
49 | ```no-highlight
50 | fastlane run notify parameter1:"value1" parameter2:"value2"
51 | ```
52 |
53 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
54 |
55 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
56 |
57 |
58 |
59 | ## Source code
60 |
61 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
62 |
63 |
64 |
65 | Back to actions
66 |
--------------------------------------------------------------------------------
/docs/generated/actions/opt_out_crash_reporting.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # opt_out_crash_reporting
7 |
8 |
9 | This will prevent reports from being uploaded when _fastlane_ crashes
10 |
11 |
12 |
13 |
14 | > _fastlane_ doesn't have crash reporting anymore. Feel free to remove `opt_out_crash_reporting` from your Fastfile.
15 |
16 |
17 | opt_out_crash_reporting ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @mpirri, @ohayon
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 | ## Documentation
31 |
32 | To show the documentation in your terminal, run
33 | ```no-highlight
34 | fastlane action opt_out_crash_reporting
35 | ```
36 |
37 |
38 |
39 | ## CLI
40 |
41 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
42 |
43 | ```no-highlight
44 | fastlane run opt_out_crash_reporting
45 | ```
46 |
47 | To pass parameters, make use of the `:` symbol, for example
48 |
49 | ```no-highlight
50 | fastlane run opt_out_crash_reporting parameter1:"value1" parameter2:"value2"
51 | ```
52 |
53 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
54 |
55 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
56 |
57 |
58 |
59 | ## Source code
60 |
61 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
62 |
63 |
64 |
65 | Back to actions
66 |
--------------------------------------------------------------------------------
/docs/generated/actions/opt_out_usage.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # opt_out_usage
7 |
8 |
9 | This will stop uploading the information which actions were run
10 |
11 |
12 |
13 |
14 | > By default, _fastlane_ will track what actions are being used. No personal/sensitive information is recorded.
Learn more at [https://docs.fastlane.tools/#metrics](https://docs.fastlane.tools/#metrics).
Add `opt_out_usage` at the top of your Fastfile to disable metrics collection.
15 |
16 |
17 | opt_out_usage ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | opt_out_usage # add this to the top of your Fastfile
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action opt_out_usage
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run opt_out_usage
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run opt_out_usage parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/plugin_scores.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # plugin_scores
7 |
8 |
9 | [31mNo description provided[0m
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | plugin_scores |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 |
25 |
26 | ## Parameters
27 |
28 | Key | Description | Default
29 | ----|-------------|--------
30 |
31 | * = default value is dependent on the user's system
32 |
33 |
34 |
35 | To show the documentation in your terminal, run
36 | ```no-highlight
37 | fastlane action plugin_scores
38 | ```
39 |
40 | View source code
41 |
42 |
43 |
44 | Back to actions
45 |
--------------------------------------------------------------------------------
/docs/generated/actions/println.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # println
7 |
8 |
9 | Alias for the `puts` action
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | println ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | puts "Hi there"
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `message` | Message to be printed out |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action println
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run println
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run println parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/push_git_tags.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # push_git_tags
7 |
8 |
9 | Push local tags to the remote - this will only push tags
10 |
11 |
12 |
13 |
14 | > If you only want to push the tags and nothing else, you can use the `push_git_tags` action
15 |
16 |
17 | push_git_tags ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @vittoriom
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | push_git_tags
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `force` | Force push to remote | `false`
39 | `remote` | The remote to push tags to | `origin`
40 | `tag` | The tag to push to remote |
41 |
42 | * = default value is dependent on the user's system
43 |
44 |
45 |
46 |
47 |
48 |
49 | ## Documentation
50 |
51 | To show the documentation in your terminal, run
52 | ```no-highlight
53 | fastlane action push_git_tags
54 | ```
55 |
56 |
57 |
58 | ## CLI
59 |
60 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
61 |
62 | ```no-highlight
63 | fastlane run push_git_tags
64 | ```
65 |
66 | To pass parameters, make use of the `:` symbol, for example
67 |
68 | ```no-highlight
69 | fastlane run push_git_tags parameter1:"value1" parameter2:"value2"
70 | ```
71 |
72 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
73 |
74 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
75 |
76 |
77 |
78 | ## Source code
79 |
80 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
81 |
82 |
83 |
84 | Back to actions
85 |
--------------------------------------------------------------------------------
/docs/generated/actions/puts.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # puts
7 |
8 |
9 | Prints out the given text
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | puts ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | puts "Hi there"
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `message` | Message to be printed out |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action puts
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run puts
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run puts parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/recreate_schemes.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # recreate_schemes
7 |
8 |
9 | Recreate not shared Xcode project schemes
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | recreate_schemes ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @jerolimov
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | recreate_schemes(project: "./path/to/MyApp.xcodeproj")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `project` | The Xcode project |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action recreate_schemes
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run recreate_schemes
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run recreate_schemes parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/restore_file.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # restore_file
7 |
8 |
9 | This action restore your file that was backed up with the `backup_file` action
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | restore_file ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @gin0606
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | restore_file(path: "/path/to/file")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `path` | Original file name you want to restore |
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action restore_file
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run restore_file
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run restore_file parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/rocket.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # rocket
7 |
8 |
9 | Outputs ascii-art for a rocket 🚀
10 |
11 |
12 |
13 |
14 | > Print an ascii Rocket :rocket:. Useful after using _crashlytics_ or _pilot_ to indicate that your new build has been shipped to outer-space.
15 |
16 |
17 | rocket ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @JaviSoto, @radex
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | rocket
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action rocket
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run rocket
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run rocket parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/rspec.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # rspec
7 |
8 |
9 | Run tests using rspec
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | rspec |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 |
25 |
26 |
27 | To show the documentation in your terminal, run
28 | ```no-highlight
29 | fastlane action rspec
30 | ```
31 |
32 | View source code
33 |
34 |
35 |
36 | Back to actions
37 |
--------------------------------------------------------------------------------
/docs/generated/actions/rsync.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # rsync
7 |
8 |
9 | Rsync files from :source to :destination
10 |
11 |
12 |
13 |
14 | > A wrapper around `rsync`, which is a tool that lets you synchronize files, including permissions and so on. For a more detailed information about `rsync`, please see [rsync(1) man page](https://linux.die.net/man/1/rsync).
15 |
16 |
17 | rsync ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @hjanuschka
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | rsync(
28 | source: "root@host:/tmp/1.txt",
29 | destination: "/tmp/local_file.txt"
30 | )
31 | ```
32 |
33 |
34 |
35 |
36 |
37 | ## Parameters
38 |
39 | Key | Description | Default
40 | ----|-------------|--------
41 | `extra` | Port | `-av`
42 | `source` | source file/folder |
43 | `destination` | destination file/folder |
44 |
45 | * = default value is dependent on the user's system
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Documentation
53 |
54 | To show the documentation in your terminal, run
55 | ```no-highlight
56 | fastlane action rsync
57 | ```
58 |
59 |
60 |
61 | ## CLI
62 |
63 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
64 |
65 | ```no-highlight
66 | fastlane run rsync
67 | ```
68 |
69 | To pass parameters, make use of the `:` symbol, for example
70 |
71 | ```no-highlight
72 | fastlane run rsync parameter1:"value1" parameter2:"value2"
73 | ```
74 |
75 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
76 |
77 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
78 |
79 |
80 |
81 | ## Source code
82 |
83 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
84 |
85 |
86 |
87 | Back to actions
88 |
--------------------------------------------------------------------------------
/docs/generated/actions/rubocop.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # rubocop
7 |
8 |
9 | Runs the code style checks
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | rubocop |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 |
25 |
26 |
27 | To show the documentation in your terminal, run
28 | ```no-highlight
29 | fastlane action rubocop
30 | ```
31 |
32 | View source code
33 |
34 |
35 |
36 | Back to actions
37 |
--------------------------------------------------------------------------------
/docs/generated/actions/ruby_version.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # ruby_version
7 |
8 |
9 | Verifies the minimum ruby version required
10 |
11 |
12 |
13 |
14 | > Add this to your `Fastfile` to require a certain version of _ruby_.
Put it at the top of your `Fastfile` to ensure that _fastlane_ is executed appropriately.
15 |
16 |
17 | ruby_version ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @sebastianvarela
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | ruby_version("2.4.0")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action ruby_version
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run ruby_version
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run ruby_version parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/say.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # say
7 |
8 |
9 | This action speaks the given text out loud
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | say ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | say("I can speak")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `text` | Text to be spoken out loud (as string or array of strings) |
39 | `mute` | If say should be muted with text printed out | `false`
40 |
41 | * = default value is dependent on the user's system
42 |
43 |
44 |
45 |
46 |
47 |
48 | ## Documentation
49 |
50 | To show the documentation in your terminal, run
51 | ```no-highlight
52 | fastlane action say
53 | ```
54 |
55 |
56 |
57 | ## CLI
58 |
59 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
60 |
61 | ```no-highlight
62 | fastlane run say
63 | ```
64 |
65 | To pass parameters, make use of the `:` symbol, for example
66 |
67 | ```no-highlight
68 | fastlane run say parameter1:"value1" parameter2:"value2"
69 | ```
70 |
71 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
72 |
73 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
74 |
75 |
76 |
77 | ## Source code
78 |
79 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
80 |
81 |
82 |
83 | Back to actions
84 |
--------------------------------------------------------------------------------
/docs/generated/actions/set_pod_key.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # set_pod_key
7 |
8 |
9 | Sets a value for a key with cocoapods-keys
10 |
11 |
12 |
13 |
14 | > Adds a key to [cocoapods-keys](https://github.com/orta/cocoapods-keys)
15 |
16 |
17 | set_pod_key ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @marcelofabri
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | set_pod_key(
28 | key: "APIToken",
29 | value: "1234",
30 | project: "MyProject"
31 | )
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `use_bundle_exec` | Use bundle exec when there is a Gemfile presented | `true`
43 | `key` | The key to be saved with cocoapods-keys |
44 | `value` | The value to be saved with cocoapods-keys |
45 | `project` | The project name |
46 |
47 | * = default value is dependent on the user's system
48 |
49 |
50 |
51 |
52 |
53 |
54 | ## Documentation
55 |
56 | To show the documentation in your terminal, run
57 | ```no-highlight
58 | fastlane action set_pod_key
59 | ```
60 |
61 |
62 |
63 | ## CLI
64 |
65 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
66 |
67 | ```no-highlight
68 | fastlane run set_pod_key
69 | ```
70 |
71 | To pass parameters, make use of the `:` symbol, for example
72 |
73 | ```no-highlight
74 | fastlane run set_pod_key parameter1:"value1" parameter2:"value2"
75 | ```
76 |
77 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
78 |
79 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
80 |
81 |
82 |
83 | ## Source code
84 |
85 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
86 |
87 |
88 |
89 | Back to actions
90 |
--------------------------------------------------------------------------------
/docs/generated/actions/setup_circle_ci.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # setup_circle_ci
7 |
8 |
9 | Setup the keychain and match to work with CircleCI
10 |
11 |
12 |
13 |
14 | > - Creates a new temporary keychain for use with match
15 | - Switches match to `readonly` mode to not create new profiles/cert on CI
16 | - Sets up log and test result paths to be easily collectible
17 | >
18 | This action helps with CircleCI integration. Add this to the top of your Fastfile if you use CircleCI.
19 |
20 |
21 | setup_circle_ci ||
22 | ---|---
23 | Supported platforms | ios, android, mac
24 | Author | @dantoml
25 |
26 |
27 |
28 | ## 1 Example
29 |
30 | ```ruby
31 | setup_circle_ci
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `force` | Force setup, even if not executed by CircleCI | `false`
43 |
44 | * = default value is dependent on the user's system
45 |
46 |
47 |
48 |
49 |
50 |
51 | ## Documentation
52 |
53 | To show the documentation in your terminal, run
54 | ```no-highlight
55 | fastlane action setup_circle_ci
56 | ```
57 |
58 |
59 |
60 | ## CLI
61 |
62 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
63 |
64 | ```no-highlight
65 | fastlane run setup_circle_ci
66 | ```
67 |
68 | To pass parameters, make use of the `:` symbol, for example
69 |
70 | ```no-highlight
71 | fastlane run setup_circle_ci parameter1:"value1" parameter2:"value2"
72 | ```
73 |
74 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
75 |
76 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
77 |
78 |
79 |
80 | ## Source code
81 |
82 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
83 |
84 |
85 |
86 | Back to actions
87 |
--------------------------------------------------------------------------------
/docs/generated/actions/setup_travis.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # setup_travis
7 |
8 |
9 | Setup the keychain and match to work with Travis CI
10 |
11 |
12 |
13 |
14 | > - Creates a new temporary keychain for use with match
15 | - Switches match to `readonly` mode to not create new profiles/cert on CI
16 | >
17 | This action helps with Travis integration. Add this to the top of your Fastfile if you use Travis.
18 |
19 |
20 | setup_travis ||
21 | ---|---
22 | Supported platforms | ios, android, mac
23 | Author | @KrauseFx
24 |
25 |
26 |
27 | ## 1 Example
28 |
29 | ```ruby
30 | setup_travis
31 | ```
32 |
33 |
34 |
35 |
36 |
37 | ## Parameters
38 |
39 | Key | Description | Default
40 | ----|-------------|--------
41 | `force` | Force setup, even if not executed by travis | `false`
42 |
43 | * = default value is dependent on the user's system
44 |
45 |
46 |
47 |
48 |
49 |
50 | ## Documentation
51 |
52 | To show the documentation in your terminal, run
53 | ```no-highlight
54 | fastlane action setup_travis
55 | ```
56 |
57 |
58 |
59 | ## CLI
60 |
61 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
62 |
63 | ```no-highlight
64 | fastlane run setup_travis
65 | ```
66 |
67 | To pass parameters, make use of the `:` symbol, for example
68 |
69 | ```no-highlight
70 | fastlane run setup_travis parameter1:"value1" parameter2:"value2"
71 | ```
72 |
73 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
74 |
75 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
76 |
77 |
78 |
79 | ## Source code
80 |
81 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
82 |
83 |
84 |
85 | Back to actions
86 |
--------------------------------------------------------------------------------
/docs/generated/actions/skip_docs.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # skip_docs
7 |
8 |
9 | Skip the creation of the fastlane/README.md file when running fastlane
10 |
11 |
12 |
13 |
14 | > Tell _fastlane_ to not automatically create a `fastlane/README.md` when running _fastlane_. You can always trigger the creation of this file manually by running `fastlane docs`.
15 |
16 |
17 | skip_docs ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | skip_docs
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action skip_docs
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run skip_docs
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run skip_docs parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/slack_train.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # slack_train
7 |
8 |
9 | Show a train of the fastlane progress
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | slack_train |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @@KrauseFx
21 | Returns | A string that is being sent to slack
22 |
23 |
24 |
25 |
26 |
27 |
28 | To show the documentation in your terminal, run
29 | ```no-highlight
30 | fastlane action slack_train
31 | ```
32 |
33 | View source code
34 |
35 |
36 |
37 | Back to actions
38 |
--------------------------------------------------------------------------------
/docs/generated/actions/slack_train_crash.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # slack_train_crash
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | slack_train_crash |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @@KrauseFx
21 |
22 |
23 |
24 |
25 |
26 |
27 | To show the documentation in your terminal, run
28 | ```no-highlight
29 | fastlane action slack_train_crash
30 | ```
31 |
32 | View source code
33 |
34 |
35 |
36 | Back to actions
37 |
--------------------------------------------------------------------------------
/docs/generated/actions/slack_train_start.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # slack_train_start
7 |
8 |
9 | Show a train of the fastlane progress
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | slack_train_start |
18 | -----|----
19 | Supported platforms | ios, android, mac
20 | Author | @@KrauseFx
21 |
22 |
23 |
24 |
25 |
26 | ## Parameters
27 |
28 | Key | Description | Default
29 | ----|-------------|--------
30 | `distance` | How many rails do we need? | `5`
31 | `train` | Train emoji | `🚝`
32 | `rail` | Character or emoji for the rail | `=`
33 | `reverse_direction` | Pass true if you want the train to go from left to right | `false`
34 |
35 | * = default value is dependent on the user's system
36 |
37 |
38 |
39 | To show the documentation in your terminal, run
40 | ```no-highlight
41 | fastlane action slack_train_start
42 | ```
43 |
44 | View source code
45 |
46 |
47 |
48 | Back to actions
49 |
--------------------------------------------------------------------------------
/docs/generated/actions/spaceship_stats.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # spaceship_stats
7 |
8 |
9 | Print out Spaceship stats from this session (number of request to each domain)
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | spaceship_stats ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @joshdholtz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | spaceship_stats
28 | ```
29 |
30 |
31 |
32 |
33 |
34 | ## Parameters
35 |
36 | Key | Description | Default
37 | ----|-------------|--------
38 | `print_request_logs` | Print all URLs requested | `false`
39 |
40 | * = default value is dependent on the user's system
41 |
42 |
43 |
44 |
45 |
46 |
47 | ## Documentation
48 |
49 | To show the documentation in your terminal, run
50 | ```no-highlight
51 | fastlane action spaceship_stats
52 | ```
53 |
54 |
55 |
56 | ## CLI
57 |
58 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
59 |
60 | ```no-highlight
61 | fastlane run spaceship_stats
62 | ```
63 |
64 | To pass parameters, make use of the `:` symbol, for example
65 |
66 | ```no-highlight
67 | fastlane run spaceship_stats parameter1:"value1" parameter2:"value2"
68 | ```
69 |
70 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
71 |
72 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
73 |
74 |
75 |
76 | ## Source code
77 |
78 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
79 |
80 |
81 |
82 | Back to actions
83 |
--------------------------------------------------------------------------------
/docs/generated/actions/team_id.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # team_id
7 |
8 |
9 | Specify the Team ID you want to use for the Apple Developer Portal
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | team_id ||
18 | ---|---
19 | Supported platforms | ios
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | team_id("Q2CBPK58CA")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action team_id
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run team_id
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run team_id parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/team_name.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # team_name
7 |
8 |
9 | Set a team to use by its name
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | team_name ||
18 | ---|---
19 | Supported platforms | ios
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | team_name("Felix Krause")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action team_name
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run team_name
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run team_name parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/typetalk.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # typetalk
7 |
8 |
9 | Post a message to [Typetalk](https://www.typetalk.com/)
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | typetalk ||
18 | ---|---
19 | Supported platforms | ios, android, mac
20 | Author | @Nulab Inc.
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | typetalk(
28 | message: "App successfully released!",
29 | note_path: "ChangeLog.md",
30 | topicId: 1,
31 | success: true,
32 | typetalk_token: "Your Typetalk Token"
33 | )
34 | ```
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 | ## Documentation
45 |
46 | To show the documentation in your terminal, run
47 | ```no-highlight
48 | fastlane action typetalk
49 | ```
50 |
51 |
52 |
53 | ## CLI
54 |
55 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
56 |
57 | ```no-highlight
58 | fastlane run typetalk
59 | ```
60 |
61 | To pass parameters, make use of the `:` symbol, for example
62 |
63 | ```no-highlight
64 | fastlane run typetalk parameter1:"value1" parameter2:"value2"
65 | ```
66 |
67 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
68 |
69 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
70 |
71 |
72 |
73 | ## Source code
74 |
75 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
76 |
77 |
78 |
79 | Back to actions
80 |
--------------------------------------------------------------------------------
/docs/generated/actions/update_project_team.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # update_project_team
7 |
8 |
9 | Update Xcode Development Team ID
10 |
11 |
12 |
13 |
14 | > This action updates the Developer Team ID of your Xcode project.
15 |
16 |
17 | update_project_team ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @lgaches
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | update_project_team
28 | ```
29 |
30 | ```ruby
31 | update_project_team(
32 | path: "Example.xcodeproj",
33 | teamid: "A3ZZVJ7CNY"
34 | )
35 | ```
36 |
37 |
38 |
39 |
40 |
41 | ## Parameters
42 |
43 | Key | Description | Default
44 | ----|-------------|--------
45 | `path` | Path to your Xcode project | [*](#parameters-legend-dynamic)
46 | `targets` | Name of the targets you want to update |
47 | `teamid` | The Team ID you want to use | [*](#parameters-legend-dynamic)
48 |
49 | * = default value is dependent on the user's system
50 |
51 |
52 |
53 |
54 |
55 |
56 | ## Documentation
57 |
58 | To show the documentation in your terminal, run
59 | ```no-highlight
60 | fastlane action update_project_team
61 | ```
62 |
63 |
64 |
65 | ## CLI
66 |
67 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
68 |
69 | ```no-highlight
70 | fastlane run update_project_team
71 | ```
72 |
73 | To pass parameters, make use of the `:` symbol, for example
74 |
75 | ```no-highlight
76 | fastlane run update_project_team parameter1:"value1" parameter2:"value2"
77 | ```
78 |
79 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
80 |
81 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
82 |
83 |
84 |
85 | ## Source code
86 |
87 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
88 |
89 |
90 |
91 | Back to actions
92 |
--------------------------------------------------------------------------------
/docs/generated/actions/verify_pod_keys.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # verify_pod_keys
7 |
8 |
9 | Verifies all keys referenced from the Podfile are non-empty
10 |
11 |
12 |
13 |
14 | > Runs a check against all keys specified in your Podfile to make sure they're more than a single character long. This is to ensure you don't deploy with stubbed keys.
15 |
16 |
17 | verify_pod_keys ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @ashfurrow
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | verify_pod_keys
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action verify_pod_keys
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run verify_pod_keys
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run verify_pod_keys parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/verify_xcode.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # verify_xcode
7 |
8 |
9 | Verifies that the Xcode installation is properly signed by Apple
10 |
11 |
12 |
13 |
14 | > This action was implemented after the recent Xcode attack to make sure you're not using a [hacked Xcode installation](http://researchcenter.paloaltonetworks.com/2015/09/novel-malware-xcodeghost-modifies-xcode-infects-apple-ios-apps-and-hits-app-store/).
15 |
16 |
17 | verify_xcode ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | verify_xcode
28 | ```
29 |
30 | ```ruby
31 | verify_xcode(xcode_path: "/Applications/Xcode.app")
32 | ```
33 |
34 |
35 |
36 |
37 |
38 | ## Parameters
39 |
40 | Key | Description | Default
41 | ----|-------------|--------
42 | `xcode_path` | The path to the Xcode installation to test | [*](#parameters-legend-dynamic)
43 |
44 | * = default value is dependent on the user's system
45 |
46 |
47 |
48 |
49 |
50 |
51 | ## Documentation
52 |
53 | To show the documentation in your terminal, run
54 | ```no-highlight
55 | fastlane action verify_xcode
56 | ```
57 |
58 |
59 |
60 | ## CLI
61 |
62 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
63 |
64 | ```no-highlight
65 | fastlane run verify_xcode
66 | ```
67 |
68 | To pass parameters, make use of the `:` symbol, for example
69 |
70 | ```no-highlight
71 | fastlane run verify_xcode parameter1:"value1" parameter2:"value2"
72 | ```
73 |
74 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
75 |
76 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
77 |
78 |
79 |
80 | ## Source code
81 |
82 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
83 |
84 |
85 |
86 | Back to actions
87 |
--------------------------------------------------------------------------------
/docs/generated/actions/xcarchive.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xcarchive
7 |
8 |
9 | Archives the project using `xcodebuild`
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | xcarchive ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xcarchive
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action xcarchive
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run xcarchive
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run xcarchive parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/xcbuild.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xcbuild
7 |
8 |
9 | Builds the project using `xcodebuild`
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | xcbuild ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xcbuild
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action xcbuild
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run xcbuild
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run xcbuild parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/xcclean.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xcclean
7 |
8 |
9 | Cleans the project using `xcodebuild`
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | xcclean ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xcclean
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action xcclean
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run xcclean
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run xcclean parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/xcexport.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xcexport
7 |
8 |
9 | Exports the project using `xcodebuild`
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | xcexport ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xcexport
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action xcexport
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run xcexport
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run xcexport parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/xcode_select.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xcode_select
7 |
8 |
9 | Change the xcode-path to use. Useful for beta versions of Xcode
10 |
11 |
12 |
13 |
14 | > Select and build with the Xcode installed at the provided path.
Use the `xcodes` action if you want to select an Xcode:
- Based on a version specifier or
- You don't have known, stable paths, as may happen in a CI environment.
15 |
16 |
17 | xcode_select ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xcode_select("/Applications/Xcode-8.3.2.app")
28 | ```
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 | ## Documentation
39 |
40 | To show the documentation in your terminal, run
41 | ```no-highlight
42 | fastlane action xcode_select
43 | ```
44 |
45 |
46 |
47 | ## CLI
48 |
49 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
50 |
51 | ```no-highlight
52 | fastlane run xcode_select
53 | ```
54 |
55 | To pass parameters, make use of the `:` symbol, for example
56 |
57 | ```no-highlight
58 | fastlane run xcode_select parameter1:"value1" parameter2:"value2"
59 | ```
60 |
61 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
62 |
63 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
64 |
65 |
66 |
67 | ## Source code
68 |
69 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
70 |
71 |
72 |
73 | Back to actions
74 |
--------------------------------------------------------------------------------
/docs/generated/actions/xcodebuild.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xcodebuild
7 |
8 |
9 | Use the `xcodebuild` command to build and sign your app
10 |
11 |
12 |
13 |
14 | > **Note**: `xcodebuild` is a complex command, so it is recommended to use [_gym_](https://docs.fastlane.tools/actions/gym/) for building your ipa file and [_scan_](https://docs.fastlane.tools/actions/scan/) for testing your app instead.
15 |
16 |
17 | xcodebuild ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xcodebuild(
28 | archive: true,
29 | archive_path: "./build-dir/MyApp.xcarchive",
30 | scheme: "MyApp",
31 | workspace: "MyApp.xcworkspace"
32 | )
33 | ```
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 | ## Documentation
44 |
45 | To show the documentation in your terminal, run
46 | ```no-highlight
47 | fastlane action xcodebuild
48 | ```
49 |
50 |
51 |
52 | ## CLI
53 |
54 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
55 |
56 | ```no-highlight
57 | fastlane run xcodebuild
58 | ```
59 |
60 | To pass parameters, make use of the `:` symbol, for example
61 |
62 | ```no-highlight
63 | fastlane run xcodebuild parameter1:"value1" parameter2:"value2"
64 | ```
65 |
66 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
67 |
68 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
69 |
70 |
71 |
72 | ## Source code
73 |
74 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
75 |
76 |
77 |
78 | Back to actions
79 |
--------------------------------------------------------------------------------
/docs/generated/actions/xctest.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xctest
7 |
8 |
9 | Runs tests on the given simulator
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | xctest ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @dtrenz
21 |
22 |
23 |
24 | ## 1 Example
25 |
26 | ```ruby
27 | xctest(
28 | destination: "name=iPhone 7s,OS=10.0"
29 | )
30 | ```
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 | ## Documentation
41 |
42 | To show the documentation in your terminal, run
43 | ```no-highlight
44 | fastlane action xctest
45 | ```
46 |
47 |
48 |
49 | ## CLI
50 |
51 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
52 |
53 | ```no-highlight
54 | fastlane run xctest
55 | ```
56 |
57 | To pass parameters, make use of the `:` symbol, for example
58 |
59 | ```no-highlight
60 | fastlane run xctest parameter1:"value1" parameter2:"value2"
61 | ```
62 |
63 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
64 |
65 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
66 |
67 |
68 |
69 | ## Source code
70 |
71 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
72 |
73 |
74 |
75 | Back to actions
76 |
--------------------------------------------------------------------------------
/docs/generated/actions/xctool.md:
--------------------------------------------------------------------------------
1 |
5 |
6 | # xctool
7 |
8 |
9 | Run tests using xctool
10 |
11 |
12 |
13 |
14 | > You can run any `xctool` action. This will require having [xctool](https://github.com/facebook/xctool) installed through [Homebrew](http://brew.sh).
It is recommended to store the build configuration in the `.xctool-args` file.
More information: [https://docs.fastlane.tools/actions/xctool/](https://docs.fastlane.tools/actions/xctool/).
15 |
16 |
17 | xctool ||
18 | ---|---
19 | Supported platforms | ios, mac
20 | Author | @KrauseFx
21 |
22 |
23 |
24 | ## 2 Examples
25 |
26 | ```ruby
27 | xctool(:test)
28 | ```
29 |
30 | ```ruby
31 | # If you prefer to have the build configuration stored in the `Fastfile`:
32 | xctool(:test, [
33 | "--workspace", "'AwesomeApp.xcworkspace'",
34 | "--scheme", "'Schema Name'",
35 | "--configuration", "Debug",
36 | "--sdk", "iphonesimulator",
37 | "--arch", "i386"
38 | ].join(" "))
39 | ```
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 | ## Documentation
50 |
51 | To show the documentation in your terminal, run
52 | ```no-highlight
53 | fastlane action xctool
54 | ```
55 |
56 |
57 |
58 | ## CLI
59 |
60 | It is recommended to add the above action into your `Fastfile`, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
61 |
62 | ```no-highlight
63 | fastlane run xctool
64 | ```
65 |
66 | To pass parameters, make use of the `:` symbol, for example
67 |
68 | ```no-highlight
69 | fastlane run xctool parameter1:"value1" parameter2:"value2"
70 | ```
71 |
72 | It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
73 |
74 | It is recommended to add all _fastlane_ actions you use to your `Fastfile`.
75 |
76 |
77 |
78 | ## Source code
79 |
80 | This action, just like the rest of _fastlane_, is fully open source, view the source code on GitHub
81 |
82 |
83 |
84 | Back to actions
85 |
--------------------------------------------------------------------------------
/docs/getting-started/android/release-deployment.md:
--------------------------------------------------------------------------------
1 | {!docs/includes/setup-fastlane-header.md!}
2 |
3 | # Deploy to Google Play using _fastlane_
4 |
5 | ## Building your app
6 |
7 | _fastlane_ takes care of building your app by delegating to your existing Gradle build. Just add the following to your `Fastfile`:
8 |
9 | ```ruby
10 | lane :playstore do
11 | gradle(
12 | task: 'assemble',
13 | build_type: 'Release'
14 | )
15 | end
16 | ```
17 |
18 | Try running the lane with:
19 |
20 | ```no-highlight
21 | fastlane playstore
22 | ```
23 |
24 | When that completes you should have the appropriate APK ready to go in the standard output directory. To get a list of all available parameters for the `gradle` action, run:
25 |
26 | ```no-highlight
27 | fastlane action gradle
28 | ```
29 |
30 | ## Uploading your APK
31 |
32 | To upload your binary to Google Play, _fastlane_ uses a tool called _supply_. Because _supply_ needs authentication information from Google, if you haven't yet done the [_supply_ setup steps](setup.md), please do those now!
33 |
34 | With that done, simply add a call to _supply_ to the lane you set up above:
35 |
36 | ```ruby
37 | lane :playstore do
38 | gradle(
39 | task: 'assemble',
40 | build_type: 'Release'
41 | )
42 | upload_to_play_store # Uploads the APK built in the gradle step above and releases it to all production users
43 | end
44 | ```
45 |
46 | This will also:
47 |
48 | - Upload app metadata from `fastlane/metadata/android` if you previously ran `fastlane supply init`
49 | - Upload expansion files (obbs) found under the same directory as your APK as long as:
50 | - They are identified by type as **main** or **patch** by containing `main` or `patch` in their file names
51 | - There is at most one of each type
52 | - Upload screenshots from `fastlane/metadata/android` if you previously ran _screengrab_
53 | - Create a new production build
54 | - Release the production build to all users
55 |
56 | If you would like to capture and upload screenshots automatically as part of your deployment process, check out the [fastlane screenshots for Android](screenshots.md) guide to get started!
57 |
58 | To gradually roll out a new build you can use:
59 |
60 | ```ruby
61 | lane :playstore do
62 | # ...
63 | upload_to_play_store(
64 | track: 'rollout',
65 | rollout: '0.5'
66 | )
67 | end
68 | ```
69 |
70 | To get a list of all available parameters for the _upload_to_play_store_ action, run:
71 |
72 | ```no-highlight
73 | fastlane action upload_to_play_store
74 | ```
75 |
--------------------------------------------------------------------------------
/docs/getting-started/cross-platform/flutter.md:
--------------------------------------------------------------------------------
1 | # Getting started with _fastlane_ for [Flutter](https://flutter.io/)
2 |
3 | Most of the _fastlane_ docs on this page apply to Flutter projects as well.
4 |
5 | To get started, the Flutter team wrote an excellent official guide on [Continuous Delivery using fastlane with Flutter](https://flutter.io/docs/deployment/fastlane-cd).
6 |
--------------------------------------------------------------------------------
/docs/getting-started/cross-platform/nativescript.md:
--------------------------------------------------------------------------------
1 | # Getting started with _fastlane_ for [NativeScript](https://www.nativescript.org/)
2 |
3 | Most of the _fastlane_ docs on this page apply to NativeScript projects as well.
4 |
5 | To get started, please follow this tutorial from the official NativeScript Blog: [Automatic NativeScript App Deployments with fastlane](https://www.nativescript.org/blog/automatic-nativescript-app-deployments-with-fastlane).
6 |
--------------------------------------------------------------------------------
/docs/getting-started/cross-platform/react-native.md:
--------------------------------------------------------------------------------
1 | # Getting started with _fastlane_ for [React Native](https://facebook.github.io/react-native/)
2 |
3 | Most of the _fastlane_ docs on this page apply to React Native projects as well.
4 |
5 | As there is no official getting started guide yet, here are some publications by the _fastlane_ community:
6 |
7 | - [Distributing beta builds with Fastlane on Android and iOS](https://thecodingmachine.github.io/react-native-boilerplate/docs/BetaBuild)
8 | - [Shipping React Native apps with fastlane](https://carloscuesta.me/blog/shipping-react-native-apps-with-fastlane/)
9 | - [React Native, fastlane and Visual Studio App Center](https://github.com/osamaq/reactnative-fastlane-appcenter)
10 | - [Conference talk "Automate your React Native world with fastlane"](https://www.youtube.com/watch?v=1K5OLv3moFg)
11 | - Team Focused Fastlane Tutorials
12 | - [Simple Android Releases in React Native](https://shift.infinite.red/simple-react-native-android-releases-319dc5e29605)
13 | - [Simple iOS Releases in React Native](https://shift.infinite.red/simple-react-native-ios-releases-4c28bb53a97b)
14 | - [Automatic Screenshots with Fastlane & Detox for React Native](https://medium.com/@mra.ghamkhar/automatic-screenshots-with-fastlane-detox-fe5f7e855e51)
15 | - [Automating React Native deployments for iOS with Fastlane](https://rhysc.me/blog/automate-react-native-deployment-fastlane)
16 |
--------------------------------------------------------------------------------
/docs/img/actions/Beta-Group-Alias.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/Beta-Group-Alias.png
--------------------------------------------------------------------------------
/docs/img/actions/Beta-Groups-Nav.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/Beta-Groups-Nav.png
--------------------------------------------------------------------------------
/docs/img/actions/FrameitGit.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/FrameitGit.gif
--------------------------------------------------------------------------------
/docs/img/actions/GridExampleScreenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/GridExampleScreenshot.png
--------------------------------------------------------------------------------
/docs/img/actions/MacExample.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/MacExample.png
--------------------------------------------------------------------------------
/docs/img/actions/PEMRecording.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/PEMRecording.gif
--------------------------------------------------------------------------------
/docs/img/actions/PilotTextTransparent.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/PilotTextTransparent.png
--------------------------------------------------------------------------------
/docs/img/actions/PilotTextTransparentSmall.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/PilotTextTransparentSmall.png
--------------------------------------------------------------------------------
/docs/img/actions/PilotTextWhite.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/PilotTextWhite.png
--------------------------------------------------------------------------------
/docs/img/actions/PilotTransparent.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/PilotTransparent.png
--------------------------------------------------------------------------------
/docs/img/actions/QuickLookScreenshot-App.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/QuickLookScreenshot-App.png
--------------------------------------------------------------------------------
/docs/img/actions/QuickLookScreenshot-Provision.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/QuickLookScreenshot-Provision.png
--------------------------------------------------------------------------------
/docs/img/actions/QuickLookScreenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/QuickLookScreenshot.png
--------------------------------------------------------------------------------
/docs/img/actions/ScreenshotsBig.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/ScreenshotsBig.png
--------------------------------------------------------------------------------
/docs/img/actions/ScreenshotsOverview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/ScreenshotsOverview.png
--------------------------------------------------------------------------------
/docs/img/actions/SignErrors.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/SignErrors.png
--------------------------------------------------------------------------------
/docs/img/actions/UDIDPrint.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/UDIDPrint.png
--------------------------------------------------------------------------------
/docs/img/actions/cert.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/cert.gif
--------------------------------------------------------------------------------
/docs/img/actions/cert.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/cert.png
--------------------------------------------------------------------------------
/docs/img/actions/deliver.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/deliver.png
--------------------------------------------------------------------------------
/docs/img/actions/deliver_metadata.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/deliver_metadata.png
--------------------------------------------------------------------------------
/docs/img/actions/deliver_screenshots.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/deliver_screenshots.png
--------------------------------------------------------------------------------
/docs/img/actions/frameit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/frameit.png
--------------------------------------------------------------------------------
/docs/img/actions/github_repo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/github_repo.png
--------------------------------------------------------------------------------
/docs/img/actions/gym.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/gym.gif
--------------------------------------------------------------------------------
/docs/img/actions/gym.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/gym.png
--------------------------------------------------------------------------------
/docs/img/actions/gymScreenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/gymScreenshot.png
--------------------------------------------------------------------------------
/docs/img/actions/htmlPage.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/htmlPage.png
--------------------------------------------------------------------------------
/docs/img/actions/htmlPagePreview.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/htmlPagePreview.jpg
--------------------------------------------------------------------------------
/docs/img/actions/htmlPagePreviewFade.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/htmlPagePreviewFade.jpg
--------------------------------------------------------------------------------
/docs/img/actions/match.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/match.png
--------------------------------------------------------------------------------
/docs/img/actions/match_appstore_small.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/match_appstore_small.gif
--------------------------------------------------------------------------------
/docs/img/actions/match_init.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/match_init.gif
--------------------------------------------------------------------------------
/docs/img/actions/match_nuke.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/match_nuke.gif
--------------------------------------------------------------------------------
/docs/img/actions/pem.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/pem.png
--------------------------------------------------------------------------------
/docs/img/actions/pilot.ai:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/pilot.ai
--------------------------------------------------------------------------------
/docs/img/actions/precheck.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/precheck.gif
--------------------------------------------------------------------------------
/docs/img/actions/precheck.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/precheck.png
--------------------------------------------------------------------------------
/docs/img/actions/produce.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/produce.png
--------------------------------------------------------------------------------
/docs/img/actions/running-screengrab.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/running-screengrab.gif
--------------------------------------------------------------------------------
/docs/img/actions/scan.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/scan.png
--------------------------------------------------------------------------------
/docs/img/actions/scanHTML.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/scanHTML.png
--------------------------------------------------------------------------------
/docs/img/actions/scanHTMLFailing.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/scanHTMLFailing.png
--------------------------------------------------------------------------------
/docs/img/actions/scanScreenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/scanScreenshot.png
--------------------------------------------------------------------------------
/docs/img/actions/screengrab.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/screengrab.png
--------------------------------------------------------------------------------
/docs/img/actions/sigh.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/sigh.png
--------------------------------------------------------------------------------
/docs/img/actions/sighRecording.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/sighRecording.gif
--------------------------------------------------------------------------------
/docs/img/actions/slack.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/slack.png
--------------------------------------------------------------------------------
/docs/img/actions/snapshot.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/snapshot.gif
--------------------------------------------------------------------------------
/docs/img/actions/snapshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/snapshot.png
--------------------------------------------------------------------------------
/docs/img/actions/supply.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/supply.png
--------------------------------------------------------------------------------
/docs/img/actions/testSummary.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/actions/testSummary.png
--------------------------------------------------------------------------------
/docs/img/app-privacy-details-action-questions.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/app-privacy-details-action-questions.png
--------------------------------------------------------------------------------
/docs/img/app-privacy-details-action-upload.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/app-privacy-details-action-upload.png
--------------------------------------------------------------------------------
/docs/img/app-privacy-details-app-store-connect.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/app-privacy-details-app-store-connect.png
--------------------------------------------------------------------------------
/docs/img/best-practices/JenkinsIntegration.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/best-practices/JenkinsIntegration.png
--------------------------------------------------------------------------------
/docs/img/codesigning/KeychainPrivateKey.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/codesigning/KeychainPrivateKey.png
--------------------------------------------------------------------------------
/docs/img/codesigning/ProvisioningProfileSelectionManual.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/codesigning/ProvisioningProfileSelectionManual.png
--------------------------------------------------------------------------------
/docs/img/codesigning/ProvisioningProfileSelectionNew.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/codesigning/ProvisioningProfileSelectionNew.png
--------------------------------------------------------------------------------
/docs/img/codesigning/XcodeAutomaticallyManageSigning.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/codesigning/XcodeAutomaticallyManageSigning.png
--------------------------------------------------------------------------------
/docs/img/codesigning/auto_signing.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/codesigning/auto_signing.png
--------------------------------------------------------------------------------
/docs/img/contributing/UI.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/contributing/UI.png
--------------------------------------------------------------------------------
/docs/img/fastlane_text.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/fastlane_text.png
--------------------------------------------------------------------------------
/docs/img/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/favicon.ico
--------------------------------------------------------------------------------
/docs/img/getting-started/android/creating-service-account.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/android/creating-service-account.png
--------------------------------------------------------------------------------
/docs/img/getting-started/android/fastlane-init.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/android/fastlane-init.png
--------------------------------------------------------------------------------
/docs/img/getting-started/android/running-screengrab.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/android/running-screengrab.gif
--------------------------------------------------------------------------------
/docs/img/getting-started/android/screengrab-results.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/android/screengrab-results.png
--------------------------------------------------------------------------------
/docs/img/getting-started/android/supply-init.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/android/supply-init.png
--------------------------------------------------------------------------------
/docs/img/getting-started/ios/boarding-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/ios/boarding-screenshot.png
--------------------------------------------------------------------------------
/docs/img/getting-started/ios/fastlane-init.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/ios/fastlane-init.png
--------------------------------------------------------------------------------
/docs/img/getting-started/ios/frameit-results.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/ios/frameit-results.png
--------------------------------------------------------------------------------
/docs/img/getting-started/ios/htmlPagePreviewFade.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/ios/htmlPagePreviewFade.jpg
--------------------------------------------------------------------------------
/docs/img/getting-started/ios/snapshot.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/docs/img/getting-started/ios/snapshot.gif
--------------------------------------------------------------------------------
/docs/includes/installing-fastlane-ios.md:
--------------------------------------------------------------------------------
1 | ### Xcode command line tools (macOS)
2 |
3 | ```no-highlight
4 | xcode-select --install
5 | ```
6 |
--------------------------------------------------------------------------------
/docs/includes/installing-fastlane.md:
--------------------------------------------------------------------------------
1 | _fastlane_ can be installed in multiple ways. The preferred method is with [_Bundler_](https://bundler.io). _fastlane_ can also be installed directly through Homebrew (if on macOS). It is possible to use macOS's system Ruby, but it's not recommended, as it can be hard to manage dependencies and cause conflicts.
2 |
3 | #### Managed Ruby environment + Bundler (macOS/Linux/Windows)
4 |
5 | **Ruby**
6 |
7 | If you use macOS, system Ruby is not recommended. [There are a variety of ways to install Ruby without having to modify your system environment](https://www.ruby-lang.org/en/documentation/installation/#managers). For macOS and Linux, _rbenv_ is one of the most popular ways to manage your Ruby environment.
8 |
9 | _fastlane_ supports Ruby versions 2.5 or newer. Verify which Ruby version you're using:
10 |
11 | ```sh
12 | $ ruby --version
13 | ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]
14 | ```
15 |
16 | **Bundler**
17 |
18 | It is recommended that you use _Bundler_ and `Gemfile` to define your dependency on _fastlane_. This will clearly define the _fastlane_ version to be used and its dependencies, and will also speed up _fastlane_ execution.
19 |
20 | - Install _Bundler_ by running `gem install bundler`
21 | - Create a `./Gemfile` in the root directory of your project with the content
22 | ```ruby
23 | source "https://rubygems.org"
24 |
25 | gem "fastlane"
26 | ```
27 | - Run `bundle update` and add both the `./Gemfile` and the `./Gemfile.lock` to version control
28 | - Every time you run _fastlane_, use `bundle exec fastlane [lane]`
29 | - On your CI, add `bundle install` as your first build step
30 | - To update _fastlane_, just run `bundle update fastlane`
31 |
32 | #### Homebrew (macOS)
33 |
34 | This way, you don't have to install Ruby separately, and instead _homebrew_ installs the adequate Ruby version for _fastlane_.
35 | See [this page](https://formulae.brew.sh/formula/fastlane) for details.
36 |
37 | ```sh
38 | brew install fastlane
39 | ```
40 |
41 | #### System Ruby + RubyGems (macOS/Linux/Windows)
42 |
43 | This is not recommended for your local environment, but you can still install _fastlane_ to system Ruby's environment. Using `sudo` often occurs unwanted results later due to file permission and makes managing your environment harder.
44 |
45 | ```sh
46 | sudo gem install fastlane
47 | ```
48 |
--------------------------------------------------------------------------------
/docs/includes/setup-fastlane-header.md:
--------------------------------------------------------------------------------
1 |
25 |
26 |
27 | New to fastlane? Click here to open the installation & setup instructions first
28 |
29 |
30 |
31 |
32 | ```no-highlight
33 | xcode-select --install
34 | ```
35 |
36 |
37 |
38 | ```sh
39 | # Using RubyGems
40 | sudo gem install fastlane -NV
41 |
42 | # Alternatively using Homebrew
43 | brew install fastlane
44 | ```
45 |
46 |
47 |
48 | ```no-highlight
49 | fastlane init
50 | ```
51 |
52 | More Details
53 |
54 |
55 |
--------------------------------------------------------------------------------
/docs/plugins/create-plugin.md:
--------------------------------------------------------------------------------
1 | # Create your own fastlane plugin
2 |
3 | ```no-highlight
4 | cd ~/new/folder/
5 |
6 | fastlane new_plugin [plugin_name]
7 | ```
8 |
9 | - _fastlane_ creates the directory structure that's needed to be a valid Ruby gem
10 | - Edit the `lib/fastlane/plugin/[plugin_name]/actions/[plugin_name].rb` and implement your action
11 | - Easily test the plugin locally by running `fastlane add_plugin` in your project's directory and specifying the local path when asked for it
12 |
13 | ## New plugin for existing gem
14 |
15 | If you already have an existing gem you want to provide a _fastlane_ plugin for, you'll still have to create a new Ruby gem. The reason for that is the way plugins are imported.
16 |
17 | The example project [xcake](https://github.com/jcampbell05/xcake) contains a folder named `fastlane-plugin-xcake`.
18 |
19 | All you have to do if you have an existing gem:
20 |
21 | - Navigate to your gem
22 | - `fastlane new_plugin [plugin_name]`
23 | - Inside the newly created folder, edit the `fastlane-plugin-[plugin_name].gemspec` and add your gem as a dependency. It is recommended to also specify a version number requirement
24 |
25 | ## Publishing your plugin
26 |
27 | ### RubyGems
28 |
29 | The recommended way to publish your plugin is to publish it on [RubyGems.org](https://rubygems.org). Follow the steps below to publish your plugin.
30 |
31 | 1. Create an account at [RubyGems.org](https://rubygems.org)
32 | 2. Publish your plugin to a [GitHub](https://github.com) repo
33 | 3. Update the `fastlane-plugin-[plugin_name].gemspec` file so that the `spec.homepage` points to your github repo.
34 | 4. Publish the first release of your plugin:
35 | ```sh
36 | bundle install
37 | rake install
38 | rake release
39 | ```
40 |
41 | Now all your users can run `fastlane add_plugin [plugin_name]` to install and use your plugin.
42 |
43 | ### GitHub
44 |
45 | If for some reason you don't want to use RubyGems, you can also make your plugin available on GitHub. Your users then need to add the following to the `Pluginfile`
46 |
47 | ```ruby
48 | gem "fastlane-plugin-[plugin_name]", git: "https://github.com/[user]/[plugin_name]"
49 | ```
50 |
51 | ## Advanced
52 |
53 | ### Multiple actions in one plugin
54 |
55 | Let's assume you work on a _fastlane_ plugin for project management software. You could call it `fastlane-plugin-pm` and it may contain any number of actions and helpers, just add them to your `actions` folder. Make sure to mention the available actions in your plugin's `README.md`.
56 |
--------------------------------------------------------------------------------
/docs/plugins/plugins-troubleshooting.md:
--------------------------------------------------------------------------------
1 | # fastlane plugins troubleshooting
2 |
3 | If you're having trouble calling a plugin action, here is a simple guide on how to resolve the issue:
4 |
5 | ### Make sure fastlane is up to date
6 |
7 | Run `fastlane -v` and `bundle exec fastlane -v` and make sure it's at least version 1.93.0.
8 |
9 | ### Update your plugins
10 |
11 | Run `fastlane update_plugins` to make sure to have all the latest plugins and their dependencies installed.
12 |
13 | ### Use `bundle exec`
14 |
15 | Run _fastlane_ using `bundle exec fastlane [lane]` to make sure your plugins are properly loaded.
16 |
17 | This is required when you use plugins from a local path or a git remote.
18 |
19 | ### Use the `--verbose` mode
20 |
21 | Running `fastlane [lane] --verbose` will show a lot more information that might be useful to resolve the issue.
22 |
23 | ### Make sure the action name is correct
24 |
25 | A plugin can contain any number of actions. Make sure to read the docs for the plugin itself!
26 |
27 | Additionally check out the source code of the plugin:
28 |
29 | ```
30 | lib/fastlane/plugin/[plugin_name]/actions/[action_name].rb
31 | ```
32 |
33 | Open the `[action_name].rb` file and make sure the name of the class on line 3 looks like this:
34 |
35 | ```
36 | class [ActionName]Action < Action
37 | ```
38 |
39 | Note how the name of the class should be capitalised and have `Action` appended in the name. Additionally this class must be a subclass of `Action`.
40 |
41 | ### Gemfile and Pluginfile
42 |
43 | Your `Gemfile` should look something like this:
44 |
45 | ```ruby
46 | gem "fastlane"
47 |
48 | plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
49 | eval_gemfile(plugins_path) if File.exist?(plugins_path)
50 | ```
51 |
52 | Your `Pluginfile` should look something like this
53 |
54 | ```ruby
55 | # Autogenerated by fastlane
56 |
57 | gem 'fastlane-plugin-ruby'
58 | ```
59 |
60 | ### Building your own plugin
61 |
62 | If you have issues with running your local plugins during plugin development, make sure to run
63 |
64 | ```
65 | bundle install --with development
66 | ```
67 |
68 | to install all required development dependencies
69 |
70 | ### More help
71 |
72 | If it's still not working for you, please [submit a new GitHub issue](https://github.com/fastlane/fastlane/issues/new) with your `Gemfile`, `Gemfile.lock`, `Pluginfile`, `Fastfile` and terminal output when running _fastlane_ using the `--verbose` flag.
73 |
--------------------------------------------------------------------------------
/fastlane/README.md:
--------------------------------------------------------------------------------
1 | fastlane documentation
2 | ----
3 |
4 | # Installation
5 |
6 | Make sure you have the latest version of the Xcode command line tools installed:
7 |
8 | ```sh
9 | xcode-select --install
10 | ```
11 |
12 | For _fastlane_ installation instructions, see [Installing _fastlane_](https://docs.fastlane.tools/#installing-fastlane)
13 |
14 | # Available Actions
15 |
16 | ### test
17 |
18 | ```sh
19 | [bundle exec] fastlane test
20 | ```
21 |
22 |
23 |
24 | ### post_slack_deploy_message
25 |
26 | ```sh
27 | [bundle exec] fastlane post_slack_deploy_message
28 | ```
29 |
30 |
31 |
32 | ### update_available_plugins
33 |
34 | ```sh
35 | [bundle exec] fastlane update_available_plugins
36 | ```
37 |
38 |
39 |
40 | ----
41 |
42 | This README.md is auto-generated and will be re-generated every time [_fastlane_](https://fastlane.tools) is run.
43 |
44 | More information about _fastlane_ can be found on [fastlane.tools](https://fastlane.tools).
45 |
46 | The documentation of _fastlane_ can be found on [docs.fastlane.tools](https://docs.fastlane.tools).
47 |
--------------------------------------------------------------------------------
/hooks.py:
--------------------------------------------------------------------------------
1 | import os
2 | import shutil
3 |
4 | def copy_generated_files(*args, **kwargs):
5 | shutil.copy("docs/generated/available-plugins.md", "docs/plugins/available-plugins.md")
6 | shutil.copy("docs/generated/actions.md", "docs/actions.md")
7 |
8 | actions_dir="docs/actions"
9 | if os.path.isdir(actions_dir):
10 | shutil.rmtree(actions_dir)
11 | shutil.copytree("docs/generated/actions", actions_dir)
12 |
13 | if __name__ == "__main__":
14 | copy_generated_files()
15 |
--------------------------------------------------------------------------------
/scripts/ci/available_redirects.rb:
--------------------------------------------------------------------------------
1 | def docs_redirects
2 | {
3 | "codesigning/GettingStarted" => "codesigning/getting-started",
4 | "codesigning/XcodeProject/" => "/codesigning/xcode-project/",
5 | "codesigning/CommonIssues" => "codesigning/common-issues",
6 | "plugins/AvailablePlugins" => "plugins/available-plugins",
7 | "plugins/CreatePlugin" => "plugins/create-plugin",
8 | "plugins/PluginsTroubleshooting" => "plugins/plugins-troubleshooting",
9 | "actions/Actions" => "actions",
10 | "best-practices/gitignore" => "best-practices/source-control",
11 | "best-practices/SourceControl" => "best-practices/source-control",
12 | "best-practices/ContinuousIntegration" => "best-practices/continuous-integration",
13 | "actions/crashlytics" => "actions/upload_symbols_to_crashlytics"
14 | }
15 | end
16 |
--------------------------------------------------------------------------------
/scripts/ci/deploy.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # Partly taken from https://medium.com/@nielsenramon/automated-deployment-of-jekyll-projects-to-github-pages-using-kickster-and-circle-ci-6ccc0b6cb872#.qxsy1xf1m
3 |
4 |
5 | # Exit if any subcommand fails.
6 | set -e
7 |
8 | echo "Starting deploy to https://docs.fastlane.tools"
9 |
10 | # Replace all the ```ruby-skip-tests
11 | # with ```ruby
12 | # This is only used to skip running the tests for this one
13 | # The markdown parsing only works with the exact string ```ruby
14 | # This only works on Linux
15 | find ./docs/generated/actions/ -type f | xargs sed -i 's/\`\`\`ruby\-skip\-tests/\`\`\`ruby/g'
16 |
17 | # Build the docs page locally
18 | mkdocs build
19 |
20 | # Bots need names too
21 | git config --global user.email "fastlanebothelper@krausefx.com"
22 | git config --global user.name "fastlane bot"
23 |
24 | # Delete old directories (if any)
25 | rm -rf "/tmp/fl-docs"
26 | # Copy the generated website to the temporary directory
27 | cp -R "site/" "/tmp/fl-docs"
28 | # Copy the needed Ruby scripts to a temporary location (used for redirects)
29 | cp "scripts/ci/available_redirects.rb" "/tmp/"
30 | cp "scripts/ci/generate_redirects.rb" "/tmp/"
31 | # Clean all temporary files (e.g. .bundle/config and .ruby-version)
32 | git clean -f -d
33 | # Check out gh-pages and clear all files
34 | git reset --hard HEAD # we don't want the `git checkout` to cause issues (e.g. https://circleci.com/gh/fastlane/docs/730)
35 | git checkout gh-pages
36 | rm -rf *
37 | # Copy the finished HTML page to the current directory
38 | cp -R /tmp/fl-docs/* .
39 |
40 | # We need a CNAME file for GitHub
41 | echo "docs.fastlane.tools" > "CNAME"
42 |
43 | echo "Generating redirects..."
44 | ruby /tmp/generate_redirects.rb
45 |
46 | # Commit all the changes and push it to the remote
47 | git add -A
48 | git commit -m "Deployed with $(mkdocs --version)"
49 | git push origin gh-pages
50 |
51 | # Post a Slack message
52 | git checkout master
53 | bundle install
54 | bundle exec fastlane post_slack_deploy_message
55 |
56 | echo "Deployed successfully, check out https://docs.fastlane.tools"
57 | echo "If you're running this on your local machine, please make sure to reset your git user credentials (username and email) to not be the fastlane-bot-helper"
58 |
59 | exit 0
60 |
--------------------------------------------------------------------------------
/scripts/ci/generate_redirects.rb:
--------------------------------------------------------------------------------
1 | require_relative "available_redirects"
2 | require 'fileutils'
3 |
4 | puts("Generating redirects for the following URLs:")
5 | puts(docs_redirects)
6 |
7 | docs_redirects.each do |from, to|
8 | FileUtils.mkdir_p(from)
9 |
10 | full_path = File.join(from, "index.html")
11 | to = "/#{to}" unless to.start_with?("/")
12 | content = ""
13 |
14 | File.write(full_path, content)
15 | puts("Successfully created file at path '#{full_path}' to point to '#{to}'")
16 | end
17 |
--------------------------------------------------------------------------------
/theme/img/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/theme/img/favicon.ico
--------------------------------------------------------------------------------
/theme/nav.html:
--------------------------------------------------------------------------------
1 | {%- if not nav_item.is_section %}
2 | {{ nav_item.title }}
3 | {%- else %}
4 | {{ nav_item.title }}
5 | {%- endif %}
6 |
7 | {%- set navlevel = navlevel + 1 %}
8 | {%- if navlevel <= config.theme.navigation_depth
9 | and ((nav_item.is_page and nav_item.toc.items
10 | and (not config.theme.titles_only
11 | and (nav_item == page or not config.theme.collapse_navigation)))
12 | or (nav_item.is_section and nav_item.children)) %}
13 |
14 | {%-if not nav_item == nav.homepage %}
15 |
16 | {%- if nav_item.is_page %}
17 | {#- Skip first level of toc which is page title. #}
18 | {%- set toc_item = nav_item.toc.items[0] %}
19 | {%- include 'toc.html' %}
20 | {%- elif nav_item.is_section %}
21 | {%- for nav_item in nav_item.children %}
22 |
23 | {%- include 'nav.html' %}
24 |
25 | {%- endfor %}
26 | {%- endif %}
27 |
28 | {%- endif %}
29 |
30 | {%- endif %}
31 | {%- set navlevel = navlevel - 1 %}
32 |
--------------------------------------------------------------------------------
/theme/searchbox.html:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastlane/docs/df902119a7599deee80900a174228a5f9838d1bd/theme/searchbox.html
--------------------------------------------------------------------------------
/theme/toc.html:
--------------------------------------------------------------------------------
1 |
2 | {%- for toc_item in toc_item.children %}
3 | {{ toc_item.title }}
4 | {%- set navlevel = navlevel + 1 %}
5 | {%- if navlevel <= config.theme.navigation_depth and toc_item.children %}
6 |
7 | {%- include 'toc.html' %}
8 |
9 | {%- endif %}
10 | {%- set navlevel = navlevel - 1 %}
11 |
12 | {%- endfor %}
13 |
--------------------------------------------------------------------------------