test: update of docs and tests

dist/azure/gitversion/execute/task.json

@@ -108,6 +108,14 @@
       "required": false,
       "helpMarkDown": "Update versions in specified file",
       "visibleRule": "updateAssemblyInfo = true"
+    },
+    {
+      "name": "updateProjectFiles",
+      "type": "boolean",
+      "label": "Update project files",
+      "defaultValue": "false",
+      "required": false,
+      "helpMarkDown": "Whether to update versions in the project files"
     }
   ]
 }

docs/examples/azure/gitversion/execute.md

@@ -64,6 +64,10 @@ updateAssemblyInfoFilename:
   description: Update versions in specified file
   required: false
   default: ''
+updateProjectFiles:
+  description: Whether to update versions in all project files
+  required: false
+  default: 'false'
 ```
 
 ## Outputs
@@ -487,3 +491,20 @@ stages:
 ```
 
 </details>
+
+### Example 10
+
+<details>
+  <summary>Calculate the version for the build. Update the version in the project files.</summary>
+
+```yaml
+steps:
+  # gitversion/[email protected] task omitted for brevity.
+
+  - task: gitversion/[email protected]
+    displayName: Determine Version
+    inputs:
+      updateProjectFiles: true
+```
+
+</details>

docs/examples/github/gitversion/execute.md

@@ -66,6 +66,10 @@ updateAssemblyInfoFilename:
   description: Update versions in specified file
   required: false
   default: ''
+updateProjectFiles:
+  description: Whether to update versions in the project files
+  required: false
+  default: 'false'
 ```
 
 ## Outputs
@@ -458,3 +462,20 @@ jobs:
 ```
 
 </details>
+
+### Example 9
+
+<details>
+  <summary>Calculate the version for the build. Update the version in the project files.</summary>
+
+```yaml
+steps:
+  # gittools/actions/gitversion/[email protected] action omitted for brevity.
+
+  - name: Determine Version
+    uses: gittools/actions/gitversion/[email protected]
+    with:
+      updateProjectFiles: true
+```
+
+</details>

gitversion/execute/action.yml

@@ -47,6 +47,10 @@ inputs:
     description: Update versions in specified file
     required: false
     default: ''
+  updateProjectFiles:
+    description: Whether to update versions in the project files
+    required: false
+    default: 'false'
 outputs:
   major: # id of output
     description: 'The Major value'

src/__tests__/tools/gitversion/settings.spec.ts

@@ -14,7 +14,8 @@ describe('GitVersion settings', () => {
             configFilePath: 'path',
             overrideConfig: ['update-build-number=false'],
             updateAssemblyInfo: true,
-            updateAssemblyInfoFilename: 'path'
+            updateAssemblyInfoFilename: 'path',
+            updateProjectFiles: true
         }
 
         const buildAgent = {

src/__tests__/tools/gitversion/tool.spec.ts

@@ -251,6 +251,14 @@ describe('GitVersionTool', () => {
             } as ExecuteSettings)
             expect(args).toEqual(['workdir', '/output', 'json', '/l', 'console', '/config', 'workdir/GitVersion.yml', '/updateassemblyinfo', 'AssemblyInfo.cs'])
         })
+
+        it('should return correct arguments for settings with project files', async () => {
+            tool.init(true)
+            const args = await tool.getExecuteArguments('workdir', {
+                updateProjectFiles: true
+            } as ExecuteSettings)
+            expect(args).toEqual(['workdir', '/output', 'json', '/l', 'console', '/updateprojectfiles'])
+        })
     })
 
     describe('getCommandArguments', () => {