Add new GitVersion 6.6.0 output variables: VersionSourceSemVer, VersionSourceDistance, VersionSourceIncrement

dist/azure/gitversion/execute/task.json

@@ -38,6 +38,116 @@
       "isExpanded": false
     }
   ],
+  "outputVariables": [
+    {
+      "name": "major",
+      "description": "The Major value"
+    },
+    {
+      "name": "minor",
+      "description": "The Minor value"
+    },
+    {
+      "name": "patch",
+      "description": "The Patch value"
+    },
+    {
+      "name": "preReleaseTag",
+      "description": "The PreReleaseTag value"
+    },
+    {
+      "name": "preReleaseTagWithDash",
+      "description": "The PreReleaseTagWithDash value"
+    },
+    {
+      "name": "preReleaseLabel",
+      "description": "The PreReleaseLabel value"
+    },
+    {
+      "name": "preReleaseNumber",
+      "description": "The PreReleaseNumber value"
+    },
+    {
+      "name": "weightedPreReleaseNumber",
+      "description": "The WeightedPreReleaseNumber value"
+    },
+    {
+      "name": "buildMetaData",
+      "description": "The BuildMetaData value"
+    },
+    {
+      "name": "fullBuildMetaData",
+      "description": "The FullBuildMetaData value"
+    },
+    {
+      "name": "majorMinorPatch",
+      "description": "The MajorMinorPatch value"
+    },
+    {
+      "name": "semVer",
+      "description": "The SemVer value"
+    },
+    {
+      "name": "assemblySemVer",
+      "description": "The AssemblySemVer value"
+    },
+    {
+      "name": "assemblySemFileVer",
+      "description": "The AssemblySemFileVer value"
+    },
+    {
+      "name": "fullSemVer",
+      "description": "The FullSemVer value"
+    },
+    {
+      "name": "informationalVersion",
+      "description": "The InformationalVersion value"
+    },
+    {
+      "name": "branchName",
+      "description": "The BranchName value"
+    },
+    {
+      "name": "escapedBranchName",
+      "description": "The EscapedBranchName value"
+    },
+    {
+      "name": "sha",
+      "description": "The Sha value"
+    },
+    {
+      "name": "shortSha",
+      "description": "The ShortSha value"
+    },
+    {
+      "name": "versionSourceSha",
+      "description": "The VersionSourceSha value"
+    },
+    {
+      "name": "commitsSinceVersionSource",
+      "description": "The CommitsSinceVersionSource value (deprecated in 6.6.0, use versionSourceDistance instead; will be removed in v7.0.0)"
+    },
+    {
+      "name": "versionSourceSemVer",
+      "description": "The VersionSourceSemVer value (since 6.6.0)"
+    },
+    {
+      "name": "versionSourceDistance",
+      "description": "The VersionSourceDistance value (since 6.6.0)"
+    },
+    {
+      "name": "versionSourceIncrement",
+      "description": "The VersionSourceIncrement value (since 6.6.0)"
+    },
+    {
+      "name": "uncommittedChanges",
+      "description": "The UncommittedChanges value"
+    },
+    {
+      "name": "commitDate",
+      "description": "The CommitDate value"
+    }
+  ],
   "inputs": [
     {
       "name": "targetPath",

docs/examples/azure/gitversion/execute.md

@@ -104,8 +104,11 @@ The Execute GitVersion task creates the following job-scoped variables and multi
 - nuGetPreReleaseTagV2 (removed in 6.0.0)
 - nuGetPreReleaseTag (removed in 6.0.0)
 - versionSourceSha
-- commitsSinceVersionSource
+- commitsSinceVersionSource (deprecated in 6.6.0, use versionSourceDistance instead; will be removed in v7.0.0)
 - commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0)
+- versionSourceSemVer (since 6.6.0)
+- versionSourceDistance (since 6.6.0)
+- versionSourceIncrement (since 6.6.0)
 - uncommittedChanges (since 5.5.0)
 - commitDate
 

docs/examples/github/gitversion/execute.md

@@ -100,8 +100,11 @@ The Execute GitVersion action creates the following outputs:
 - nuGetPreReleaseTagV2 (removed in 6.0.0)
 - nuGetPreReleaseTag (removed in 6.0.0)
 - versionSourceSha
-- commitsSinceVersionSource
+- commitsSinceVersionSource (deprecated in 6.6.0, use versionSourceDistance instead; will be removed in v7.0.0)
 - commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0)
+- versionSourceSemVer (since 6.6.0)
+- versionSourceDistance (since 6.6.0)
+- versionSourceIncrement (since 6.6.0)
 - uncommittedChanges (since 5.5.0)
 - commitDate
 

gitversion/execute/action.yml

@@ -90,7 +90,13 @@ outputs:
   versionSourceSha:
     description: 'The VersionSourceSha value'
   commitsSinceVersionSource:
-    description: 'The CommitsSinceVersionSource value'
+    description: 'The CommitsSinceVersionSource value (deprecated in 6.6.0, use versionSourceDistance instead; will be removed in v7.0.0)'
+  versionSourceSemVer:
+    description: 'The VersionSourceSemVer value (since 6.6.0)'
+  versionSourceDistance:
+    description: 'The VersionSourceDistance value (since 6.6.0)'
+  versionSourceIncrement:
+    description: 'The VersionSourceIncrement value (since 6.6.0)'
   uncommittedChanges:
     description: 'The UncommittedChanges value'
   commitDate:

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

@@ -273,6 +273,9 @@ function createGitVersionFixture(params: {
         BuildMetaData: buildMetaData,
         CommitDate: commitDate,
         CommitsSinceVersionSource: buildMetaData,
+        VersionSourceSemVer: '1.2.3',
+        VersionSourceDistance: buildMetaData,
+        VersionSourceIncrement: 'Patch',
         EscapedBranchName: escapedBranchName,
         FullBuildMetaData: fullBuildMetaData,
         FullSemVer: fullSemVer,

src/tools/gitversion/models.ts

@@ -42,6 +42,9 @@ export type GitVersionOutput = {
     ShortSha: string
     VersionSourceSha: string
     CommitsSinceVersionSource: number
+    VersionSourceSemVer?: string
+    VersionSourceDistance?: number
+    VersionSourceIncrement?: string
     UncommittedChanges: number
     CommitDate: string
 }