Clarify remove identity step input (#48)

* Clarify remove identity step input

* Update README

* *

Author: ofalvai

README.md

@@ -14,7 +14,7 @@ This Step makes sure Bitrise has access to your repository and thus able to clon
 By default, you do not have to change anything about the Step's configuration. All you need to do is make sure that you registered your key pair on Bitrise and the public key at your Git provider. You can generate and register an SSH keypair in two ways.
 
 - Automatically during the [app creation process](https://devcenter.bitrise.io/getting-started/adding-a-new-app/#setting-up-ssh-keys).
-- Manually during the app creation process or at any other time. You [generate your own SSH keys](https://devcenter.bitrise.io/faq/how-to-generate-ssh-keypair/) and register them on Bitrise and at your Git provider. The SSH key should not have a passphrase! 
+- Manually during the app creation process or at any other time. You [generate your own SSH keys](https://devcenter.bitrise.io/faq/how-to-generate-ssh-keypair/) and register them on Bitrise and at your Git provider. The SSH key should not have a passphrase!
 
 Optionally, you can save the private key on the virtual machine. If a key already exists on the path you specified in the **(Optional) path to save the private key** input, it will be overwritten.
 
@@ -47,9 +47,9 @@ You can also run this step directly with [Bitrise CLI](https://github.com/bitris
 
 | Key | Description | Flags | Default |
 | --- | --- | --- | --- |
-| `ssh_rsa_private_key` |  | sensitive | `$SSH_RSA_PRIVATE_KEY` |
-| `ssh_key_save_path` |  |  | `$HOME/.ssh/bitrise_step_activate_ssh_key` |
-| `is_remove_other_identities` | (Optional) Remove other or previously loaded keys and restart ssh-agent?  Options:  * "true" * "false" |  | `true` |
+| `ssh_rsa_private_key` | The private key of the SSH keypair in RSA format. | sensitive | `$SSH_RSA_PRIVATE_KEY` |
+| `ssh_key_save_path` | Path where the private key should be saved |  | `$HOME/.ssh/bitrise_step_activate_ssh_key` |
+| `is_remove_other_identities` | When the step detects a running SSH agent and this input is true, it removes all loaded identities and restarts the agent before loading the configured key.  When there is no running SSH agent, this input has no effect.  Note: this only affects the in-memory SSH agent data, keys on disk are not touched.  Options:  * "true" * "false" |  | `true` |
 | `verbose` | Enable verbose log option for better debug | required | `false` |
 </details>
 

step.yml

@@ -51,21 +51,27 @@ toolkit:
 inputs:
 - ssh_rsa_private_key: $SSH_RSA_PRIVATE_KEY
   opts:
-    title: SSH private key in RSA format
+    title: SSH private key content
+    description: |-
+      The private key of the SSH keypair in RSA format.
     is_expand: true
     is_dont_change_value: true
     is_sensitive: true
 - ssh_key_save_path: $HOME/.ssh/bitrise_step_activate_ssh_key
   opts:
-    title: |-
-      (Optional) path to save the private key.
+    title: SSH key save path
+    description: Path where the private key should be saved
     is_expand: true
     is_dont_change_value: true
 - is_remove_other_identities: "true"
   opts:
-    title: Remove other identities?
+    title: Remove other identities from SSH agent
     description: |-
-      (Optional) Remove other or previously loaded keys and restart ssh-agent?
+      When the step detects a running SSH agent and this input is true, it removes all loaded identities and restarts the agent before loading the configured key.
+
+      When there is no running SSH agent, this input has no effect.
+
+      Note: this only affects the in-memory SSH agent data, keys on disk are not touched.
 
       Options:
 
@@ -75,7 +81,6 @@ inputs:
     value_options:
     - "true"
     - "false"
-    is_dont_change_value: true
 - verbose: "false"
   opts:
     title: Enable verbose logging