Merge pull request #17 from thecodingmachine/feature/README

Updating the docs/beta builds.md

Author: AurelGit

docs/beta builds.md

@@ -4,6 +4,7 @@ Developers love writing React Native code but no one likes deploying React Nativ
 
 All your headaches will disappear with this documentation and the amazing [Fastlane](https://fastlane.tools/) tool :)
 
+
 ## Before you start
 
 You need a Mac. I'm sorry, but if you are a Windows user, you can stop reading right now.  
@@ -14,25 +15,27 @@ Let's explain which tools we are using to distribute beta builds:
 * [TestFlight](https://developer.apple.com/testflight/), part of App Store Connect, let you build your iOS app and invite internal or external users to test it
 * [Google Play](https://support.google.com/googleplay/android-developer/answer/3131213?hl=fr), which does the same job as TestFlight for Android apps
 
+
 ## Installing Fastlane
 
 First you need to install Fastlane on your Mac. Follow these steps:
 
 1. Install the latest Xcode command line tools:
 ```
-xcode-select --install
+$ xcode-select --install
 ```
 2. Install Ruby using [Homebrew](https://brew.sh/):
 ```
-brew install ruby
+$ brew install ruby
 ```
 3. Install Fastlane with RubyGems:
 ```
-sudo gem install fastlane -NV
+$ sudo gem install fastlane -NV
 ```
 
  You are now ready to set up Fastlane for iOS and Android :rocket:
 
+
 ## iOS
 
 ### Prerequisites
@@ -44,21 +47,35 @@ Before continuing make sure you have:
 - [ ] An Apple ID with an admin user, with its username (email, for example `[email protected]`) and password
 - [ ] Your app name, if not already created on the Developer Portal (for example `TCM React Native Boilerplate`). Fastlane can create applications in the Developer Portal and App Store Connect, so it's recommended to let Fastlane do the job for you.
 - [ ] Use the right [.gitignore](ios/.gitignore) file inside the `ios` directory
+- [ ] You also need to create an App Icon to use Fastlane or you will get an error on running `fastlane beta`. You can simply create one on using the website [AppIconMaker](http://appiconmaker.co/)
 
 Open your Xcode project and modify some information:
 
-- [ ] In the `General` tab, `Identity` section, change the `Bundle Identifier` to your identifier
+- [ ] In the `General` tab, `Identity` section, change the `Bundle Identifier` to your identifier (useful for Fastlane)
 - [ ] In the `General` tab, `Signing` section, disable `Automatically manage signing`
-- [ ] In the `Build Settings` tab, under `Signing`, set `Don't Code Sign` as the `debug` codesigning identity and `iOS Distribution` as the `release` codesigning identity (for both `Debug`/`Release` and `Any iOS SDK`).
+- [ ] In the `Build Settings` tab, `Signing` section and into `Code Signing Identity`, set `Don't Code Sign` for the `debug` line (including `Any iOS SDK` also) and set `iOS Distribution` for the `release` line (including `Any iOS SDK` also).
+
+Like this:
+
+| Code Signing Identity  | < Multiple values > |
+| ------------- | ------------- |
+| Debug  | Don't Code Sign  |
+| Any iOS SDK  | Don't Code Sign  |
+| Release  | iOS Distribution  |
+| Any iOS SDK  | iOS Distribution  |
+
 
 ### Setting up
 
 First you need to set up Fastlane for your iOS project:
 ```
-cd my-project/ios
-fastlane init
+$ cd my-project/ios
+$ fastlane init
 ```
 
+*Note: If you have an error on this step, please see the `issues` section.*
+
+
 Fastlane will automatically detect your project and ask for any missing information.
 
 The following questions will be asked:
@@ -73,18 +90,6 @@ The following questions will be asked:
   * If you don't know, you didn't read the "Prerequisites" step :)  
   Our answer is `keep it secret`
 
-At this step, you may have the following issue:
-```
-fastlane init failed
-["The request could not be completed because:", "Could not receive latest API key from App Store Connect, this might be a server issue."]
-Something failed while running `fastlane init`
-Tried using Apple ID with email '[email protected]'
-You can either retry, or fallback to manual setup which will create a basic Fastfile
-Would you like to fallback to a manual Fastfile? (y/n)
-```
-Answer `n`, and retry previous steps with a correct Apple ID and password.  
-Make sure you are connected to internet.
-
 * If your account has multiple teams in the App Store Connect, you may have this question: `Multiple App Store Connect teams found, please enter the number of the team you want to use:`
   * Select the right team 
 * If your account has multiple teams in the Developer Portal, you may have this question: `Multiple teams found on the Developer Portal, please enter the number of the team you want to use:`
@@ -97,7 +102,8 @@ Make sure you are connected to internet.
 
 Fastlane will then give you some information about git, the files it will create, etc. Just type `enter` to continue.
 
-Congrats! Fastlane has created some files.  
+**Congrats!** Fastlane has created some files.  
+
 If you are using Git, commit all generated files.
 
 Once the setup has finished you can see a new folder inside the `ios` folder:
@@ -107,6 +113,10 @@ Once the setup has finished you can see a new folder inside the `ios` folder:
    - Fastfile
 ```
 
+It's not finish, you need to follow `Code Signing` part to setting up a provisioning profile.
+
+For information:
+
 `Appfile` contains identifiers used to connect to the Developer Portal and App Store Connect.
 You can read more about this file [here](https://docs.fastlane.tools/advanced/#appfile).
 
@@ -118,6 +128,7 @@ This `lane` contains 3 actions:
 * build your app
 * upload to TestFlight
 
+
 ### Code signing
 
 Signing your app assures users that it is from a known source and the app hasn’t been modified since it was last signed. Before your app can integrate app services, be installed on a device, or be submitted to the App Store, it must be signed with a certificate issued by Apple.
@@ -127,7 +138,7 @@ A full guide is available on the fastlane doc, describing the best approaches fo
 Using `match` is probably [the best solution](https://codesigning.guide/).  
 Because we don't want to revoke our existing certificates, but still want an automated setup, we will use [cert and sigh](https://docs.fastlane.tools/codesigning/getting-started/#using-cert-and-sigh).
 
-Add the following to your `Fastfile`, just after the `increment_build_number` function and before `build_app`:
+Add the following lines to your `Fastfile`, just after the `increment_build_number` function and before `build_app` (Note that you will need to replace some information):
 ```
     get_certificates( # Create or get certificate, and install it
       output_path: "./builds" # Download certificate in the build folder (you don't need to create the folder)
@@ -149,7 +160,7 @@ Add the following to your `Fastfile`, just after the `increment_build_number` fu
 
 Then, we need to configure the provisioning profile for the build step.
 
-Add the following to your `Fastfile`, inside the `build_app` function, just after the `scheme` parameter:
+Add the following lines to your `Fastfile`, inside the `build_app` function, just after the `scheme` parameter (Make sure you add a `,` after the `scheme` parameter):
 ```
     clean: true,
     export_method: "app-store",
@@ -161,7 +172,6 @@ Add the following to your `Fastfile`, inside the `build_app` function, just afte
     build_path: "./builds",
     output_directory: "./builds"
 ```
-Make sure you have a `,` after the `scheme` parameter.
 
 Thanks to this the Certificates and Provisioning Profile will be automatically created when you will create a beta build!  
 :rocket: You are now ready to create your first beta build.
@@ -173,8 +183,8 @@ Creating a beta build and uploading it on TestFlight is now really easy.
 Just type the following:
 
 ```
-cd my-project/ios
-fastlane beta
+$ cd my-project/ios
+$ fastlane beta
 ```
 
 
@@ -197,8 +207,8 @@ Before continuing make sure you have:
 
 First you need to set up Fastlane for your android project:
 ```
-cd my-project/android
-fastlane init
+$ cd my-project/android
+$ fastlane init
 ```
 
 Fastlane will automatically detect your project and ask for any missing information.
@@ -250,18 +260,35 @@ Creating a beta build and uploading it on Google Play is now really easy.
 Just type the following:
 
 ```
-cd my-project/android
-fastlane beta
+$ cd my-project/android
+$ fastlane beta
 ```
 
 If you have a `Permission denied` issue, please run:
 ```
-chmod a+x /my-project/android/gradlew
+$ chmod a+x /my-project/android/gradlew
 ```
 
+
 ## Troubleshooting
 
-### Stuck at `bundle install` running `fastlane init`
+### Stuck at `bundle install` or `bundle update` running `fastlane init`
+
+If the `fastlane init` process is stuck when running `bundle install` or `bundle update` it may mean that `bundle` command is asking for root permissions.  
+You can stop the process and retry again with `sudo fastlane init`, however you will need to change back ownership of the generated files to your user when it finishes by running this command:
+```
+$ sudo chown <your-user> <files>
+```
+
 
-If the `fastlane init` process is stuck when running `bundle install` it may mean that `bundle install` is asking for root permissions.  
-You can stop the process and retry again with `sudo fastlane init`, however you will need to change back ownership of the generated files to your user when it finishes (`sudo chown <your-user> <files>`).
+### Fastlane init failed
+```
+fastlane init failed
+["The request could not be completed because:", "Could not receive latest API key from App Store Connect, this might be a server issue."]
+Something failed while running `fastlane init`
+Tried using Apple ID with email '[email protected]'
+You can either retry, or fallback to manual setup which will create a basic Fastfile
+Would you like to fallback to a manual Fastfile? (y/n)
+```
+Answer `n`, and retry previous steps with a correct Apple ID and password.  
+Make sure you are connected to internet.