Merge pull request #760 from GitTools/dependabot/github_actions/actions/checkout-3

(build deps): Bump actions/checkout from 2 to 3

.github/dependabot.yml

@@ -1,5 +1,13 @@
 version: 2
 updates:
+- package-ecosystem: github-actions
+  labels:
+    - "dependencies"
+  commit-message:
+    prefix: "(build deps)"
+  directory: "/"
+  schedule:
+    interval: daily
 - package-ecosystem: npm
   directory: "/"
   schedule:

.github/mergify.yml

@@ -0,0 +1,23 @@
+pull_request_rules:
+  - name: Automatic approve on dependabot PR
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      review:
+        type: APPROVE
+  - name: Automatic merge on dependabot PR after success CI
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+      - '#commits-behind=0' # Only merge up to date pull requests
+      - check-success=build (windows-latest)
+      - check-success=build (ubuntu-latest)
+      - check-success=build (macos-latest)
+    actions:
+      merge:
+  - name: Thank contributor
+    conditions:
+      - merged
+      - -author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      comment:
+        message: "Thank you @{{author}} for your contribution!"

.github/workflows/ci.yml

@@ -2,11 +2,11 @@ name: CI
 on:
   push:
     branches:
-    - master
+    - main
 
   pull_request:
     branches:
-    - master
+    - main
 
 jobs:
   build:
@@ -17,7 +17,7 @@ jobs:
         os: [windows-latest, ubuntu-latest, macos-latest]
       fail-fast: false
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Fetch all history for all tags and branches
       run: |
         git fetch --prune --unshallow

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Fetch all history for all tags and branches
       run: |
         git fetch --prune --unshallow
@@ -31,7 +31,7 @@ jobs:
       id: gitversion # step id used as reference for output values
       uses: ./gitversion/execute
     - run: |
-        $date = Get-Date -format "yyMMddHHmm"
+        $date = Get-Date -format "yyMMddHH"
         $version = "${{steps.gitversion.outputs.majorMinorPatch}}.$date"
         $major = "${{steps.gitversion.outputs.major}}"
         $minor = "${{steps.gitversion.outputs.minor}}"

action.yml

@@ -5,5 +5,5 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: dist/github/setup/index.js

dist/azure/gitreleasemanager/addasset/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -64,4 +64,4 @@
         "required": false,
         "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }]
-}
+}

dist/azure/gitreleasemanager/close/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -57,4 +57,4 @@
         "required": false,
         "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }]
-}
+}

dist/azure/gitreleasemanager/create/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -92,4 +92,4 @@
         "required": false,
         "helpMarkDown": "Path(s) to the file(s) to include in the release. Separated by newline"
     }]
-}
+}

dist/azure/gitreleasemanager/discard/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -57,4 +57,4 @@
         "required": false,
         "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }]
-}
+}

dist/azure/gitreleasemanager/open/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -57,4 +57,4 @@
         "required": false,
         "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }]
-}
+}

dist/azure/gitreleasemanager/publish/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -57,4 +57,4 @@
         "required": false,
         "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }]
-}
+}

dist/azure/gitreleasemanager/setup/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -36,6 +36,14 @@
             "defaultValue": "false",
             "required": false,
             "helpMarkDown": "Include pre-release versions when matching a version"
+        },
+        {
+            "name": "ignoreFailedSources",
+            "type": "boolean",
+            "label": "Treat package source failures as warnings",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Treat package source failures as warnings"
         }
     ]
-}
+}

dist/azure/gitversion/execute/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -85,4 +85,4 @@
             "groupName": "additional"
         }
     ]
-}
+}

dist/azure/gitversion/setup/task.json

@@ -14,7 +14,7 @@
     },
     "minimumAgentVersion": "2.115.0",
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
@@ -36,6 +36,14 @@
             "defaultValue": "false",
             "required": false,
             "helpMarkDown": "Include pre-release versions when matching a version"
+        },
+        {
+            "name": "ignoreFailedSources",
+            "type": "boolean",
+            "label": "Treat package source failures as warnings",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Treat package source failures as warnings"
         }
     ]
-}
+}

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

@@ -4,6 +4,13 @@ Find out how to use the **gitversion/execute** task using the examples below.
 
 > The examples use the latest _0.x_ version of the GitVersion Execute task.  It is recommended to use the latest released version in your own pipelines.
 
+Note that if the pipeline is setup to use a shallow git fetch mode the GitVersion Execute task will fail. It is required to use fetchDepth of 0 like so:
+
+```yaml
+- checkout: self
+  fetchDepth: 0
+```
+
 ## Inputs
 
 The Execute GitVersion task accepts the following inputs:
@@ -229,7 +236,7 @@ steps:
     name: Version # the step MUST be named to access its output variables in another job.
 
 job: CreateReleaseNotes
-condition: and(succeeded(), eq(dependencies.CalculateVersion.outputs['Version.GitVersion.BranchName'], 'main')
+condition: and(succeeded(), eq(dependencies.CalculateVersion.outputs['Version.GitVersion.BranchName'], 'main'))
 dependsOn: CalculateVersion
 ```
 

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

@@ -17,6 +17,10 @@ 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
 ```
 
 ---

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

@@ -17,6 +17,10 @@ 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
 ```
 
 ---

gitreleasemanager/addasset/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/addasset/bundle.js
 inputs:
   owner:

gitreleasemanager/close/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/close/bundle.js
 inputs:
   owner:

gitreleasemanager/create/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/create/bundle.js
 inputs:
   owner:

gitreleasemanager/discard/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/discard/bundle.js
 inputs:
   owner:

gitreleasemanager/open/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/open/bundle.js
 inputs:
   owner:

gitreleasemanager/publish/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/publish/bundle.js
 inputs:
   owner:

gitreleasemanager/setup/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitreleasemanager/setup/bundle.js
 inputs:
   versionSpec:
@@ -16,3 +16,7 @@ inputs:
     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'

gitversion/execute/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitversion/execute/bundle.js
 inputs:
   targetPath:

gitversion/setup/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node16
   main: ../../dist/github/gitversion/setup/bundle.js
 inputs:
   versionSpec:
@@ -16,3 +16,7 @@ inputs:
     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'

package.json

@@ -26,30 +26,34 @@
     ],
     "license": "MIT",
     "dependencies": {
-        "@actions/core": "^1.2.6",
-        "@actions/exec": "^1.0.4",
-        "@actions/io": "^1.0.2",
-        "@actions/tool-cache": "^1.6.1",
-        "azure-pipelines-task-lib": "^2.12.0",
-        "azure-pipelines-tool-lib": "^0.13.2",
-        "inversify": "^5.0.5",
-        "typed-rest-client": "^1.8.0",
-        "uuid": "^8.3.2"
+        "@actions/core": "^1.10.0",
+        "@actions/exec": "^1.1.1",
+        "@actions/io": "^1.1.2",
+        "@actions/tool-cache": "^2.0.1",
+        "azure-pipelines-task-lib": "^3.3.1",
+        "azure-pipelines-tool-lib": "^1.3.2",
+        "inversify": "^6.0.1",
+        "typed-rest-client": "^1.8.9",
+        "uuid": "^9.0.0"
     },
     "devDependencies": {
-        "@types/node": "^14.14.20",
-        "@types/q": "^1.5.4",
+        "@types/node": "^18.11.7",
+        "@types/q": "^1.5.5",
         "@types/semver-compare": "^1.0.1",
-        "@types/uuid": "^8.3.0",
-        "minimist": "^1.2.5",
-        "prettier": "^2.2.1",
+        "@types/uuid": "^8.3.4",
+        "minimist": "^1.2.7",
+        "prettier": "^2.7.1",
         "reflect-metadata": "^0.1.13",
         "replace-in-file-webpack-plugin": "^1.0.6",
-        "terser-webpack-plugin": "^5.0.3",
-        "tfx-cli": "^0.8.3",
-        "ts-loader": "^8.0.13",
-        "typescript": "^4.1.3",
-        "webpack": "^5.11.1",
-        "webpack-cli": "^4.3.1"
+        "shelljs": "^0.8.5",
+        "terser-webpack-plugin": "^5.3.6",
+        "tfx-cli": "^0.12.0",
+        "trim-newlines": ">=4.0.2",
+        "ts-loader": "^9.4.1",
+        "typescript": "^4.8.4",
+        "underscore": ">=1.13.6",
+        "validator": "^13.7.0",
+        "webpack": "^5.74.0",
+        "webpack-cli": "^4.10.0"
     }
 }

src/core/dotnet-tool.ts

@@ -4,16 +4,15 @@ import * as path from 'path'
 import * as http from 'typed-rest-client/HttpClient'
 
 import { inject, injectable } from 'inversify'
-import { TYPES, IExecResult, IBuildAgent } from './models'
+import { TYPES, IExecResult, IBuildAgent, ISetupSettings } from './models'
 import { IVersionManager } from './versionManager'
 
 export interface IDotnetTool {
     disableTelemetry(): void
     toolInstall(
         toolName: string,
-        versionSpec: string,
         checkLatest: boolean,
-        includePre: boolean
+        setupSettings: ISetupSettings
     ): Promise<string>
 }
 
@@ -51,16 +50,17 @@ export class DotnetTool implements IDotnetTool {
 
     public async toolInstall(
         toolName: string,
-        versionSpec: string,
         checkLatest: boolean,
-        includePre: boolean
+        setupSettings: ISetupSettings
     ): Promise<string> {
         console.log('')
         console.log('--------------------------')
-        console.log(`Installing ${toolName} version ` + versionSpec)
+        console.log(
+            `Installing ${toolName} version ` + setupSettings.versionSpec
+        )
         console.log('--------------------------')
 
-        if (this.versionManager.isExplicitVersion(versionSpec)) {
+        if (this.versionManager.isExplicitVersion(setupSettings.versionSpec)) {
             checkLatest = false // check latest doesn't make sense when explicit version
         }
 
@@ -69,16 +69,18 @@ export class DotnetTool implements IDotnetTool {
             //
             // Let's try and resolve the version spec locally first
             //
-            toolPath = this.buildAgent.find(toolName, versionSpec)
+            toolPath = this.buildAgent.find(toolName, setupSettings.versionSpec)
         }
 
         if (!toolPath) {
             let version: string
-            if (this.versionManager.isExplicitVersion(versionSpec)) {
+            if (
+                this.versionManager.isExplicitVersion(setupSettings.versionSpec)
+            ) {
                 //
                 // Explicit version was specified. No need to query for list of versions.
                 //
-                version = versionSpec
+                version = setupSettings.versionSpec
             } else {
                 //
                 // Let's query and resolve the latest version for the versionSpec.
@@ -88,12 +90,12 @@ export class DotnetTool implements IDotnetTool {
                 //
                 version = await this.queryLatestMatch(
                     toolName,
-                    versionSpec,
-                    includePre
+                    setupSettings.versionSpec,
+                    setupSettings.includePrerelease
                 )
                 if (!version) {
                     throw new Error(
-                        `Unable to find ${toolName} version '${versionSpec}'.`
+                        `Unable to find ${toolName} version '${setupSettings.versionSpec}'.`
                     )
                 }
 
@@ -106,7 +108,11 @@ export class DotnetTool implements IDotnetTool {
                 //
                 // Download, extract, cache
                 //
-                toolPath = await this.acquireTool(toolName, version)
+                toolPath = await this.acquireTool(
+                    toolName,
+                    version,
+                    setupSettings.ignoreFailedSources
+                )
             }
         }
 
@@ -170,11 +176,16 @@ export class DotnetTool implements IDotnetTool {
 
     private async acquireTool(
         toolName: string,
-        version: string
+        version: string,
+        ignoreFailedSources: boolean
     ): Promise<string> {
         const tempDirectory = await this.buildAgent.createTempDir()
         let args = ['tool', 'install', toolName, '--tool-path', tempDirectory]
 
+        if (ignoreFailedSources) {
+            args.push('--ignore-failed-sources')
+        }
+
         if (version) {
             version = this.versionManager.cleanVersion(version)
             args = args.concat(['--version', version])

src/core/models.ts

@@ -10,12 +10,14 @@ export const TYPES = {
 
 export enum SetupFields {
     includePrerelease = 'includePrerelease',
-    versionSpec = 'versionSpec'
+    versionSpec = 'versionSpec',
+    ignoreFailedSources = 'ignoreFailedSources'
 }
 
 export interface ISetupSettings {
     [SetupFields.versionSpec]: string
     [SetupFields.includePrerelease]: boolean
+    [SetupFields.ignoreFailedSources]: boolean
 }
 
 export interface IExecResult {

src/core/settings.ts

@@ -6,10 +6,14 @@ export class Settings {
         const includePrerelease = buildAgent.getBooleanInput(
             SetupFields.includePrerelease
         )
+        const ignoreFailedSources = buildAgent.getBooleanInput(
+            SetupFields.ignoreFailedSources
+        )
 
         return {
             versionSpec,
-            includePrerelease
+            includePrerelease,
+            ignoreFailedSources
         }
     }
 }

src/tasks/gitreleasemanager/main.ts

@@ -23,10 +23,7 @@ export async function setup() {
 
         const settings = CommonSettings.getSetupSettings(buildAgent)
 
-        await gitReleaseManagerTool.install(
-            settings.versionSpec,
-            settings.includePrerelease
-        )
+        await gitReleaseManagerTool.install(settings)
 
         buildAgent.setSucceeded(
             'GitVersionManager installed successfully',

src/tasks/gitversion/main.ts

@@ -20,10 +20,7 @@ export async function setup() {
 
         const settings = CommonSettings.getSetupSettings(buildAgent)
 
-        await gitVersionTool.install(
-            settings.versionSpec,
-            settings.includePrerelease
-        )
+        await gitVersionTool.install(settings)
 
         buildAgent.setSucceeded('GitVersion installed successfully', true)
     } catch (error) {
@@ -42,8 +39,8 @@ export async function run() {
         const result = await gitVersionTool.run(settings)
         const { stdout } = result
         const jsonOutput = stdout.substring(
-            stdout.indexOf('{'),
-            stdout.indexOf('}') + 1
+            stdout.lastIndexOf('{'),
+            stdout.lastIndexOf('}') + 1
         )
 
         const gitversion = JSON.parse(jsonOutput) as GitVersionOutput

src/tools/gitreleasemanager/tool.ts

@@ -1,6 +1,6 @@
 import path = require('path')
 
-import { TYPES, IBuildAgent, IExecResult } from '../../core/models'
+import { TYPES, IBuildAgent, IExecResult, ISetupSettings } from '../../core/models'
 import { injectable, inject } from 'inversify'
 import { DotnetTool, IDotnetTool } from '../../core/dotnet-tool'
 import { IVersionManager } from '../../core/versionManager'
@@ -16,7 +16,7 @@ import {
 } from './models'
 
 export interface IGitReleaseManagerTool extends IDotnetTool {
-    install(versionSpec: string, includePrerelease: boolean): Promise<void>
+    install(setupSettings: ISetupSettings): Promise<void>
     create(settings: GitReleaseManagerCreateSettings): Promise<IExecResult>
     discard(settings: GitReleaseManagerDiscardSettings): Promise<IExecResult>
     close(settings: GitReleaseManagerCloseSettings): Promise<IExecResult>
@@ -36,15 +36,11 @@ export class GitReleaseManagerTool
         super(buildAgent, versionManager)
     }
 
-    public async install(
-        versionSpec: string,
-        includePrerelease: boolean
-    ): Promise<void> {
+    public async install(setupSettings: ISetupSettings): Promise<void> {
         await this.toolInstall(
             'GitReleaseManager.Tool',
-            versionSpec,
             false,
-            includePrerelease
+            setupSettings
         )
     }
 

src/tools/gitversion/tool.ts

@@ -1,13 +1,13 @@
 import path = require('path')
 
 import { injectable, inject } from 'inversify'
-import { IExecResult, IBuildAgent, TYPES } from '../../core/models'
+import { IExecResult, IBuildAgent, TYPES, ISetupSettings } from '../../core/models'
 import { DotnetTool, IDotnetTool } from '../../core/dotnet-tool'
 import { GitVersionSettings, GitVersionOutput } from './models'
 import { IVersionManager } from '../../core/versionManager'
 
 export interface IGitVersionTool extends IDotnetTool {
-    install(versionSpec: string, includePrerelease: boolean): Promise<void>
+    install(setupSettings: ISetupSettings): Promise<void>
     run(options: GitVersionSettings): Promise<IExecResult>
     writeGitVersionToAgent(gitversion: GitVersionOutput): void
 }
@@ -21,15 +21,11 @@ export class GitVersionTool extends DotnetTool implements IGitVersionTool {
         super(buildAgent, versionManager)
     }
 
-    public async install(
-        versionSpec: string,
-        includePrerelease: boolean
-    ): Promise<void> {
+    public async install(setupSettings: ISetupSettings): Promise<void> {
         await this.toolInstall(
             'GitVersion.Tool',
-            versionSpec,
             false,
-            includePrerelease
+            setupSettings
         )
     }
 
@@ -87,18 +83,22 @@ export class GitVersionTool extends DotnetTool implements IGitVersionTool {
         }
         if (updateAssemblyInfo) {
             args.push('/updateassemblyinfo')
-            if (
-                this.buildAgent.isValidInputFile(
-                    'updateAssemblyInfoFilename',
-                    updateAssemblyInfoFilename
-                )
-            ) {
-                args.push(updateAssemblyInfoFilename)
-            } else {
-                throw new Error(
-                    'AssemblyInfoFilename file not found at ' +
+
+            // You can specify 'updateAssemblyInfo' without 'updateAssemblyInfoFilename'.
+            if (updateAssemblyInfoFilename?.length > 0) {
+                if (
+                    this.buildAgent.isValidInputFile(
+                        'updateAssemblyInfoFilename',
                         updateAssemblyInfoFilename
-                )
+                    )
+                ) {
+                    args.push(updateAssemblyInfoFilename)
+                } else {
+                    throw new Error(
+                        'AssemblyInfoFilename file not found at ' +
+                            updateAssemblyInfoFilename
+                    )
+                }
             }
         }