GitTools#1053 - updated setup docs for GRM

docs/examples/azure/gitreleasemanager/setup.md

@@ -1,9 +1,55 @@
-# Example
+## Inputs
+
+The Setup GitReleaseManager action accepts the following inputs:
+
+```yaml
+versionSpec:
+  description: Required version in the form of 0.17.x or exact version like 0.17.0.
+  required: true
+  default: ''
+includePrerelease:
+  description: Include pre-release versions when matching a version.
+  required: false
+  default: false
+ignoreFailedSources:
+  description: Treat package source failures as warnings.
+  required: false
+  default: false
+```
+
+### Example 1
+
+Install the latest GitReleaseManager 0.17.x version.
+
+```yaml
+steps:
+  - task: gitreleasemanager/setup@0.13.4
+    displayName: Install GitReleaseManager
+    inputs:
+      versionSpec: '0.17.x'
+```
+
+### Example 2
+
+Install specific GitReleaseManager version 0.17.0.
+
+```yaml
+steps:
+  - task: gitreleasemanager/setup@0.13.4
+    displayName: Install GitReleaseManager
+    inputs:
+      versionSpec: '0.17.0'
+```
+
+### Example 3
+
+Install the latest GitReleaseManager 0.17.x version even it there is a cached version matching the versionSpec.
 
 ```yaml
-  steps:
+steps:
   - task: gitreleasemanager/setup@0.13.4
     displayName: Install GitReleaseManager
     inputs:
       versionSpec: '0.17.x'
+      preferLatestVersion: true
 ```

docs/examples/azure/gitversion/execute/usage-examples.md

@@ -25,27 +25,42 @@ The Execute GitVersion task accepts the following inputs:
 
 ```yaml
 targetPath:
-  description: Optionally supply the path to the working directory.
+  description: Optionally supply the path to the working directory
   required: false
   default: ''
+disableCache:
+  description: Whether to disable GitVersion cache
+  required: false
+  default: 'false'
+disableNormalization:
+  description: Whether to disable GitVersion normalization
+  required: false
+  default: 'false'
 useConfigFile:
-  description: Whether to use a custom configuration file.
+  description: Whether to use a custom configuration file
   required: false
-  default: false
+  default: 'false'
 configFilePath:
-  description: Optional path to config file (defaults to GitVersion.yml).
+  description: Optional path to config file (defaults to GitVersion.yml)
+  required: false
+  default: 'GitVersion.yml'
+overrideConfig:
+  description: |
+    Optional override for the configuration file. This should be newline-separated key-value pairs, e.g.:
+    update-build-number=false
+    next-version=1.0.0
   required: false
   default: ''
 updateAssemblyInfo:
-  description: Whether to update versions in the AssemblyInfo files.
+  description: Whether to update versions in the AssemblyInfo files
   required: false
-  default: false
+  default: 'false'
 updateAssemblyInfoFilename:
-  description: Update versions in specified file.
+  description: Update versions in specified file
   required: false
   default: ''
 additionalArguments:
-  description: Additional arguments to send to GitVersion.
+  description: Additional arguments to send to GitVersion
   required: false
   default: ''
 ```

docs/examples/github/gitreleasemanager/setup.md

@@ -1,6 +1,25 @@
+## Inputs
+
+The Setup GitReleaseManager action accepts the following inputs:
+
+```yaml
+versionSpec:
+  description: Required version in the form of 0.17.x or exact version like 0.17.0.
+  required: true
+  default: ''
+includePrerelease:
+  description: Include pre-release versions when matching a version.
+  required: false
+  default: false
+ignoreFailedSources:
+  description: Treat package source failures as warnings.
+  required: false
+  default: false
+```
+
 ### Example 1
 
-Install the latest GitReleaseManager version.
+Install the latest GitReleaseManager 0.17.x version.
 
 ```yaml
 steps:
@@ -24,7 +43,7 @@ steps:
 
 ### Example 3
 
-Install the latest GitReleaseManager version 0.17.x even it there is a cached version matching the versionSpec.
+Install the latest GitReleaseManager 0.17.x version even it there is a cached version matching the versionSpec.~~~~
 
 ```yaml
 steps:

docs/examples/github/gitversion/execute/usage-examples.md

@@ -28,27 +28,42 @@ The Execute GitVersion action accepts the following inputs:
 
 ```yaml
 targetPath:
-  description: Optionally supply the path to the working directory.
+  description: Optionally supply the path to the working directory
   required: false
   default: ''
+disableCache:
+  description: Whether to disable GitVersion cache
+  required: false
+  default: 'false'
+disableNormalization:
+  description: Whether to disable GitVersion normalization
+  required: false
+  default: 'false'
 useConfigFile:
-  description: Whether to use a custom configuration file.
+  description: Whether to use a custom configuration file
   required: false
-  default: false
+  default: 'false'
 configFilePath:
-  description: Optional path to config file (defaults to GitVersion.yml).
+  description: Optional path to config file (defaults to GitVersion.yml)
   required: false
   default: 'GitVersion.yml'
+overrideConfig:
+  description: |
+    Optional override for the configuration file. This should be newline-separated key-value pairs, e.g.:
+    update-build-number=false
+    next-version=1.0.0
+  required: false
+  default: ''
 updateAssemblyInfo:
-  description: Whether to update versions in the AssemblyInfo files.
+  description: Whether to update versions in the AssemblyInfo files
   required: false
-  default: false
+  default: 'false'
 updateAssemblyInfoFilename:
-  description: Update versions in specified file.
+  description: Update versions in specified file
   required: false
   default: ''
 additionalArguments:
-  description: Additional arguments to send to GitVersion.
+  description: Additional arguments to send to GitVersion
   required: false
   default: ''
 ```

docs/examples/github/gitversion/setup/usage-examples.md

@@ -10,7 +10,7 @@ The Setup GitVersion action accepts the following inputs:
 
 ```yaml
 versionSpec:
-  description: Required version in the form of 5.x or exact version like 5.0.0.
+  description: Required version in the form of 5.x or exact version like 5.12.0.
   required: true
   default: ''
 includePrerelease: