Merge branch 'master' into roger/update-dependencies

.ci/bundler_version.rb

@@ -0,0 +1,5 @@
+# /usr/bin/env ruby
+file = File.join(__dir__, "..", "Gemfile.lock")
+lines = File.read(file).split("\n")
+idx = lines.index { |l| l == "BUNDLED WITH" }
+puts lines[idx + 1].strip

.circleci/config.yml

@@ -9,7 +9,7 @@ jobs:
       - checkout
       - run: sudo pip3 install pipenv
       - run: pipenv install
-      - run: gem install bundler
+      - run: gem install bundler -v $(ruby .ci/bundler_version.rb)
       - run: bundle update
       - run: pipenv run bundle exec fastlane test
       - run: bundle exec rubocop
@@ -22,7 +22,7 @@ jobs:
       - checkout
       - run: sudo pip3 install pipenv
       - run: pipenv install
-      - run: gem install bundler
+      - run: gem install bundler -v $(ruby .ci/bundler_version.rb)
       - run: bundle update
       - run: pipenv run ./scripts/ci/deploy.sh
 

.rubocop.yml

@@ -173,7 +173,7 @@ Style/RedundantReturn:
 Style/IfUnlessModifier:
   Enabled: false
 
-# and and or is okay
+# "and" and "or" are okay
 Style/AndOr:
   Enabled: true
   EnforcedStyle: conditionals

Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/fastlane/fastlane
-  revision: f06aa50ffdec6f19c1468f9f2c4d9c30441aafa3
+  revision: 425719196c38bda13950d2bc0dfcb08b1e14cac1
   specs:
-    fastlane (2.215.1)
+    fastlane (2.216.0)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
@@ -276,6 +276,8 @@ GEM
 
 PLATFORMS
   ruby
+  -darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   danger (~> 8)
@@ -284,4 +286,4 @@ DEPENDENCIES
   xcov
 
 BUNDLED WITH
-   2.3.11
+   2.3.21

README.md

@@ -1,8 +1,8 @@
 # fastlane docs
 
-This repo contains all documentation for fastlane. You can find the `.md` files inside the [docs](docs) folder.
+This repository contains all documentation for fastlane. You can access the `.md` files inside the [docs](docs) folder.
 
-To preview the updated documentation locally, just clone the repo, modify the file, and run. Note that some of the files are in [generated](docs/generated) folder and are later copied with `mkdocs` pre-build hook.
+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.
 
 ```
 mkdocs serve
@@ -16,7 +16,7 @@ You can find more information [here](https://github.com/fastlane/docs/issues/5)
 
 ## Deploy changes
 
-Once a 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. No need to do anything manually. The resulting HTML files are stored in the [`gh-pages`](https://github.com/fastlane/docs/tree/gh-pages) branch.
+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.
 
 ## Installation of [mkdocs](http://www.mkdocs.org/)
 
@@ -35,6 +35,6 @@ Likely, to add a [Markdown extension](https://pythonhosted.org/Markdown/extensio
 
 ## Troubleshooting local docs server
 
-Running a local server with `mkdocs serve` takes several minutes. It looks like `mkdocs` needs some time to read `available-plugins.md`. It can be confirmed by running `mkdocs serve --verbose` as `mkdocs` is stuck at reading this file.
+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.
 
-To test 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`.
+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`.

docs/advanced/actions.md

@@ -77,7 +77,7 @@ name = UI.input("What's your name? ")
 if UI.confirm("Are you '#{name}'?")
   UI.success "Oh yeah"
 else
-  UI.error "Wups, invalid"
+  UI.error "Whoops, invalid"
 end
 
 UI.password("Your password please: ") # password inputs are hidden

docs/advanced/lanes.md

@@ -268,7 +268,7 @@ app_identifier "com.used.id"
 app_identifier "com.ignored.id"
 ```
 
-the `app_identfier` will be `"com.used.id"` and the second value will be ignored. The `for_lane` and `for_platform` configuration blocks provide a limited exception to this rule.
+the `app_identifier` will be `"com.used.id"` and the second value will be ignored. The `for_lane` and `for_platform` configuration blocks provide a limited exception to this rule.
 
 All configuration files (Appfile, Matchfile, Screengrabfile, etc.) can use `for_lane` and `for_platform` blocks to control (and override) configuration values for those circumstances.
 

docs/advanced/other.md

@@ -103,7 +103,7 @@ irb(main):005:0> branch = 'master'
 Now create an instance of `Storage` and `Encryption`. The `download` method on `Storage` will clone the repo and the `decrypt_files` method on `Encryption` will decrypt the repo for you. Assign the return values to `storage` and `encrypt`, which we'll need later when we re-encrypt:
 
 ```ruby
-irb(main):006:0> storage = Match::Storage.for_mode("git", { git_url: git_url, shallow_clone: shallow_clone, git_branch: branch, clone_branch_directly: false})
+irb(main):006:0> storage = Match::Storage.from_params({storage_mode: "git", git_url: git_url, shallow_clone: shallow_clone, git_branch: branch, clone_branch_directly: false})
 irb(main):007:0> storage.download
 irb(main):008:0> encryption = Match::Encryption.for_storage_mode("git", { git_url: git_url, working_directory: storage.working_directory})
 irb(main):009:0> encryption.decrypt_files

docs/app-store-connect-api.md

@@ -106,7 +106,7 @@ $ bundle exec fastlane match appstore \
 ```
 
 Please note that `key_content` and `key_filepath` described in `app_store_connect_api_key` action are invalid both in hash and in JSON file.
-View [Token code on Github](https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/connect_api/token.rb)
+View [Token code on GitHub](https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/connect_api/token.rb)
 
 ### Using _fastlane_ API Key JSON file
 

docs/best-practices/continuous-integration/bamboo.md

@@ -19,13 +19,13 @@ Then you could use the following regex to ignore these commits
 
 
 ## Setting repository remote
-By default bamboo will do an anonymous shallow clone of the repo.  This will not preserve the  `git remote` information nor the list of tags.  If you are using bamboo to create commits you may want to use a code block similar to the following:
+Bamboo will do an anonymous shallow clone of the repo by default. This will preserve neither the `git remote` information nor the list of tags. If you are using bamboo to create commits you may want to use a code block similar to the following:
 
 
 ```ruby
 # In prep for eventually committing a version/build bump - set the git params
 sh('git config user.name "<COMMITTER USERNAME>"')
-sh('git config user.email <COMITTER EMAIL>')
+sh('git config user.email <COMMITTER EMAIL>')
 
 # Bamboo does an anonymous checkout so in order to update the build versions must set the git repo URL
 git_remote_cmd = 'git remote set-url origin ' + ENV['bamboo_repository_git_repositoryUrl']

docs/best-practices/continuous-integration/codemagic.md

@@ -10,9 +10,9 @@ For publishing iOS apps, it is recommended to create an App Store Connect API ke
 
 The following **environment variables** need to be added to your workflow for *fastlane* integration. 
 
-- `MATCH_PASSWORD` - the password used to encrypt/decrypt the repository used to store your distrbution certificates and provisioning profiles.
+- `MATCH_PASSWORD` - the password used to encrypt/decrypt the repository used to store your distribution certificates and provisioning profiles.
 - `MATCH_KEYCHAIN` - an arbitrary name to use for the keychain on the Codemagic build server, e.g "fastlane_keychain"
-- `MATCH_SSH_KEY` - an SSH private key used for cloning the Match repository that contains your distrbution certificates and provisioning profiles. The public key should be added to your Github account. See [here](https://docs.codemagic.io/configuration/access-private-git-submodules/) for more information about accessing Git dependencies with SSH keys.
+- `MATCH_SSH_KEY` - an SSH private key used for cloning the Match repository that contains your distribution certificates and provisioning profiles. The public key should be added to your GitHub account. See [here](https://docs.codemagic.io/configuration/access-private-git-submodules/) for more information about accessing Git dependencies with SSH keys.
 - `APP_STORE_CONNECT_PRIVATE_KEY` - the App Store Connect API key. Copy the entire contents of the .p8 file and paste into the environment variable value field.
 - `APP_STORE_CONNECT_KEY_IDENTIFIER` - the key identifier of your App Store Connect API key.
 - `APP_STORE_CONNECT_ISSUER_ID` - the issuer of your App Store Connect API key.
@@ -33,7 +33,7 @@ workflows:
 
 It is recommended to run your *fastlane* lanes using the `codemagic.yaml` configuration file. 
 
-You should install your depenpendencies with `bundle install` and then execute the *fastlane* lane with `bundle exec fastlane <lane_name>` as follows:
+You should install your dependencies with `bundle install` and then execute the *fastlane* lane with `bundle exec fastlane <lane_name>` as follows:
 
 ```yaml
 scripts:

docs/best-practices/continuous-integration/jenkins.md

@@ -54,9 +54,9 @@ Under the hood `setup_jenkins` configures other actions like: _gym_, _scan_, `xc
 
 You can use `commit_version_bump` or `git_commit` action to commit changes to your repository in your fastlane setup. When you are using webhooks to trigger your build on a push this will cause an infinite loop of triggering builds.
 
-#### Gitlab
+#### GitLab
 
-When you are using Gitlab you will need the [GitLab Plugin](https://plugins.jenkins.io/gitlab-plugin). Inside the job you want to configure you go to `Build Triggers > Build when a change is pushed to GitLab > Enable [ci-skip]`.
+When you are using GitLab you will need the [GitLab Plugin](https://plugins.jenkins.io/gitlab-plugin). Inside the job you want to configure you go to `Build Triggers > Build when a change is pushed to GitLab > Enable [ci-skip]`.
 When you include `[ci-skip]` in your build this commit won't trigger the build in jenkins at all.
 
 **Example**  

docs/best-practices/xcodebuild-formatters.md

@@ -15,7 +15,7 @@ There are two main formatters the community is using. These are:
 
 As of _fastlane_ 2.201.0, `scan`, `gym`, and `snapshot` all offer a new `xcodebuild_formatter` option.
 
-This option will default to `xcbeautify` if its installed, otherwise it will fallback to `xcpretty`. However, `scan`, `gym`, and `snapshot` will end up using `xcpretty` if any options are set that are customizing with `xcpretty` (ex: `xcpretty_args`)
+This option will default to `xcbeautify` if it's installed; otherwise, it will fallback to `xcpretty`. However, _scan_, _gym_, and _snapshot_ will end up using `xcpretty` if any options are set that customize it with `xcpretty` (e.g., `xcpretty_args`).
 
 ```ruby
 scan(
@@ -26,12 +26,12 @@ scan(
   xcodebuild_formatter: "xcpretty"
 )
 
-# Specificy a local install of xcbeautify
+# Specify a local installation of xcbeautify
 scan(
   xcodebuild_formatter: "/custom/path/to/xcbeautify"
 )
 
-# Specifify your own custom formatter
+# Specify your own custom formatter
 scan(
   xcodebuild_formatter: "/custom/path/to/my_formatter"
 )
@@ -64,7 +64,7 @@ $ brew install xcbeautify
 
 #### xcpretty
 
-Historticaly, _fastlane_ was tightly integrated with [xcpretty](https://github.com/xcpretty/xcpretty). `xcpretty` is a RubyGem and a dependency of _fastlane_. This was the best option for _fastlane_ as there were no extra steps for installing or using this formatter.
+Historically, _fastlane_ was tightly integrated with [xcpretty](https://github.com/xcpretty/xcpretty). `xcpretty` is a RubyGem and a dependency of _fastlane_. This was the best option for _fastlane_ as there were no extra steps for installing or using this formatter.
 
 `xcpretty` also did more than formatting. It used the `xcodebuild` output to: