GitTools/actions
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated usage-examples

Browse Source
This commit is contained in:
Artur
2023-03-12 00:43:51 +01:00
parent c0466a77ff
commit 241a50fbd6
2 changed files with 300 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

257
docs/examples/azure/gitversion/execute/usage-examples.md
View File

@@ -46,42 +46,44 @@ additionalArguments:
The Execute GitVersion task creates the following job-scoped variables and multi-job output variables: The Execute GitVersion task creates the following job-scoped variables and multi-job output variables:
- GitVersion.Major - major
- GitVersion.Minor - minor
- GitVersion.Patch - patch
- GitVersion.PreReleaseTag - preReleaseTag
- GitVersion.PreReleaseTagWithDash - preReleaseTagWithDash
- GitVersion.PreReleaseLabel - preReleaseLabel
- GitVersion.PreReleaseNumber - preReleaseNumber
- GitVersion.WeightedPreReleaseNumber - weightedPreReleaseNumber
- GitVersion.BuildMetaData - buildMetaData
- GitVersion.BuildMetaDataPadded - buildMetaDataPadded (removed in 6.0.0)
- GitVersion.FullBuildMetaData - fullBuildMetaData
- GitVersion.MajorMinorPatch - majorMinorPatch
- GitVersion.SemVer - semVer
- GitVersion.LegacySemVer - legacySemVer (removed in 6.0.0)
- GitVersion.LegacySemVerPadded - legacySemVerPadded (removed in 6.0.0)
- GitVersion.AssemblySemVer - assemblySemVer
- GitVersion.AssemblySemFileVer - assemblySemFileVer
- GitVersion.FullSemVer - fullSemVer
- GitVersion.InformationalVersion - informationalVersion
- GitVersion.BranchName - branchName
- GitVersion.EscapedBranchName (since 5.2.0) - escapedBranchName (since 5.2.0)
- GitVersion.Sha - sha
- GitVersion.ShortSha - shortSha
- GitVersion.NuGetVersionV2 - nuGetVersionV2 (removed in 6.0.0)
- GitVersion.NuGetVersion - nuGetVersion (removed in 6.0.0)
- GitVersion.NuGetPreReleaseTagV2 - nuGetPreReleaseTagV2 (removed in 6.0.0)
- GitVersion.NuGetPreReleaseTag - nuGetPreReleaseTag (removed in 6.0.0)
- GitVersion.VersionSourceSha - versionSourceSha
- GitVersion.CommitsSinceVersionSource - commitsSinceVersionSource
- GitVersion.CommitsSinceVersionSourcePadded (since 5.2.0) - commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0)
- GitVersion.UncommittedChanges (since 5.5.0) - uncommittedChanges (since 5.5.0)
- GitVersion.CommitDate - commitDate
The job-scoped variables can be accessed using the macro syntax `$(GitVersion.<variableName>)` in subsequent steps in the same job. Azure Pipelines also creates environment variables of the form `GITVERSION_<VARIABLENAME>`. See examples [5](#example-5) and [6](#example-6). The outputs can be accessed using the syntax `$(<id>.<outputName>)` or `$(<id>.GitVersion_<OutputName>)`, where `<id>` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. See example [5](#example-5).
The multi-job output variables can be accessed across jobs and stages, in both conditions and variables. See examples [7](#example-7) to [10](#example-10). The action also creates environment variables of the form `$(<outputName>)` or `$(GitVersion_<OutputName>)` for use by other steps in the same job. See example [6](#example-6).
The multi-job output variables can be accessed across jobs and stages, in both conditions and variables. See examples [7](#example-7) to [10](#example-10).
**GitVersion also automatically updates the pre-defined Build variable `Build.BuildNumber`.** **GitVersion also automatically updates the pre-defined Build variable `Build.BuildNumber`.**
@@ -164,41 +166,78 @@ steps:
# gitversion/setup@0 task omitted for brevity. # gitversion/setup@0 task omitted for brevity.
- task: gitversion/execute@0 - task: gitversion/execute@0
name: version # id to later be referenced
displayName: Determine Version displayName: Determine Version
- script: | - displayName: Display GitVersion outputs (step output)
echo Major: $(GitVersion.Major) script: |
echo Minor: $(GitVersion.Minor) echo "Major: $(version.major)"
echo Patch: $(GitVersion.Patch) echo "Minor: $(version.minor)"
echo PreReleaseTag: $(GitVersion.PreReleaseTag) echo "Patch: $(version.patch)"
echo PreReleaseTagWithDash: $(GitVersion.PreReleaseTagWithDash) echo "PreReleaseTag: $(version.preReleaseTag)"
echo PreReleaseLabel: $(GitVersion.PreReleaseLabel) echo "PreReleaseTagWithDash: $(version.preReleaseTagWithDash)"
echo PreReleaseNumber: $(GitVersion.PreReleaseNumber) echo "PreReleaseLabel: $(version.preReleaseLabel)"
echo WeightedPreReleaseNumber: $(GitVersion.WeightedPreReleaseNumber) echo "PreReleaseNumber: $(version.preReleaseNumber)"
echo BuildMetaData: $(GitVersion.BuildMetaData) echo "WeightedPreReleaseNumber: $(version.weightedPreReleaseNumber)"
echo BuildMetaDataPadded: $(GitVersion.BuildMetaDataPadded) echo "BuildMetaData: $(version.buildMetaData)"
echo FullBuildMetaData: $(GitVersion.FullBuildMetaData) echo "BuildMetaDataPadded: $(version.buildMetaDataPadded)"
echo MajorMinorPatch: $(GitVersion.MajorMinorPatch) echo "FullBuildMetaData: $(version.fullBuildMetaData)"
echo SemVer: $(GitVersion.SemVer) echo "MajorMinorPatch: $(version.majorMinorPatch)"
echo LegacySemVer: $(GitVersion.LegacySemVer) echo "SemVer: $(version.semVer)"
echo LegacySemVerPadded: $(GitVersion.LegacySemVerPadded) echo "LegacySemVer: $(version.legacySemVer)"
echo AssemblySemVer: $(GitVersion.AssemblySemVer) echo "LegacySemVerPadded: $(version.legacySemVerPadded)"
echo AssemblySemFileVer: $(GitVersion.AssemblySemFileVer) echo "AssemblySemVer: $(version.assemblySemVer)"
echo FullSemVer: $(GitVersion.FullSemVer) echo "AssemblySemFileVer: $(version.assemblySemFileVer)"
echo InformationalVersion: $(GitVersion.InformationalVersion) echo "FullSemVer: $(version.fullSemVer)"
echo BranchName: $(GitVersion.BranchName) echo "InformationalVersion: $(version.informationalVersion)"
echo EscapedBranchName: $(GitVersion.EscapedBranchName) echo "BranchName: $(version.branchName)"
echo Sha: $(GitVersion.Sha) echo "EscapedBranchName: $(version.escapedBranchName)"
echo ShortSha: $(GitVersion.ShortSha) echo "Sha: $(version.sha)"
echo NuGetVersionV2: $(GitVersion.NuGetVersionV2) echo "ShortSha: $(version.shortSha)"
echo NuGetVersion: $(GitVersion.NuGetVersion) echo "NuGetVersionV2: $(version.nuGetVersionV2)"
echo NuGetPreReleaseTagV2: $(GitVersion.NuGetPreReleaseTagV2) echo "NuGetVersion: $(version.nuGetVersion)"
echo NuGetPreReleaseTag: $(GitVersion.NuGetPreReleaseTag) echo "NuGetPreReleaseTagV2: $(version.nuGetPreReleaseTagV2)"
echo VersionSourceSha: $(GitVersion.VersionSourceSha) echo "NuGetPreReleaseTag: $(version.nuGetPreReleaseTag)"
echo CommitsSinceVersionSource: $(GitVersion.CommitsSinceVersionSource) echo "VersionSourceSha: $(version.versionSourceSha)"
echo CommitsSinceVersionSourcePadded: $(GitVersion.CommitsSinceVersionSourcePadded) echo "CommitsSinceVersionSource: $(version.commitsSinceVersionSource)"
echo UncommittedChanges: $(GitVersion.UncommittedChanges) echo "CommitsSinceVersionSourcePadded: $(version.commitsSinceVersionSourcePadded)"
echo CommitDate: $(GitVersion.CommitDate) echo "UncommittedChanges: $(version.uncommittedChanges)"
echo "CommitDate: $(version.commitDate)"
- displayName: Display GitVersion outputs (step output with prefix)
script: |
echo "Major: $(version.GitVersion_Major)"
echo "Minor: $(version.GitVersion_Minor)"
echo "Patch: $(version.GitVersion_Patch)"
echo "PreReleaseTag: $(version.GitVersion_PreReleaseTag)"
echo "PreReleaseTagWithDash: $(version.GitVersion_PreReleaseTagWithDash)"
echo "PreReleaseLabel: $(version.GitVersion_PreReleaseLabel)"
echo "PreReleaseNumber: $(version.GitVersion_PreReleaseNumber)"
echo "WeightedPreReleaseNumber: $(version.GitVersion_WeightedPreReleaseNumber)"
echo "BuildMetaData: $(version.GitVersion_BuildMetaData)"
echo "BuildMetaDataPadded: $(version.GitVersion_BuildMetaDataPadded)"
echo "FullBuildMetaData: $(version.GitVersion_FullBuildMetaData)"
echo "MajorMinorPatch: $(version.GitVersion_MajorMinorPatch)"
echo "SemVer: $(version.GitVersion_SemVer)"
echo "LegacySemVer: $(version.GitVersion_LegacySemVer)"
echo "LegacySemVerPadded: $(version.GitVersion_LegacySemVerPadded)"
echo "AssemblySemVer: $(version.GitVersion_AssemblySemVer)"
echo "AssemblySemFileVer: $(version.GitVersion_AssemblySemFileVer)"
echo "FullSemVer: $(version.GitVersion_FullSemVer)"
echo "InformationalVersion: $(version.GitVersion_InformationalVersion)"
echo "BranchName: $(version.GitVersion_BranchName)"
echo "EscapedBranchName: $(version.GitVersion_EscapedBranchName)"
echo "Sha: $(version.GitVersion_Sha)"
echo "ShortSha: $(version.GitVersion_ShortSha)"
echo "NuGetVersionV2: $(version.GitVersion_NuGetVersionV2)"
echo "NuGetVersion: $(version.GitVersion_NuGetVersion)"
echo "NuGetPreReleaseTagV2: $(version.GitVersion_NuGetPreReleaseTagV2)"
echo "NuGetPreReleaseTag: $(version.GitVersion_NuGetPreReleaseTag)"
echo "VersionSourceSha: $(version.GitVersion_VersionSourceSha)"
echo "CommitsSinceVersionSource: $(version.GitVersion_CommitsSinceVersionSource)"
echo "CommitsSinceVersionSourcePadded: $(version.GitVersion_CommitsSinceVersionSourcePadded)"
echo "UncommittedChanges: $(version.GitVersion_UncommittedChanges)"
echo "CommitDate: $(version.GitVersion_CommitDate)"
``` ```
### Example 6 ### Example 6
@@ -212,18 +251,88 @@ steps:
- task: gitversion/execute@0 - task: gitversion/execute@0
displayName: Determine Version displayName: Determine Version
- displayName: Display GitVersion variables (without prefix)
script: |
echo "Major: $(major)"
echo "Minor: $(minor)"
echo "Patch: $(patch)"
echo "PreReleaseTag: $(preReleaseTag)"
echo "PreReleaseTagWithDash: $(preReleaseTagWithDash)"
echo "PreReleaseLabel: $(preReleaseLabel)"
echo "PreReleaseNumber: $(preReleaseNumber)"
echo "WeightedPreReleaseNumber: $(weightedPreReleaseNumber)"
echo "BuildMetaData: $(buildMetaData)"
echo "BuildMetaDataPadded: $(buildMetaDataPadded)"
echo "FullBuildMetaData: $(fullBuildMetaData)"
echo "MajorMinorPatch: $(majorMinorPatch)"
echo "SemVer: $(semVer)"
echo "LegacySemVer: $(legacySemVer)"
echo "LegacySemVerPadded: $(legacySemVerPadded)"
echo "AssemblySemVer: $(assemblySemVer)"
echo "AssemblySemFileVer: $(assemblySemFileVer)"
echo "FullSemVer: $(fullSemVer)"
echo "InformationalVersion: $(informationalVersion)"
echo "BranchName: $(branchName)"
echo "EscapedBranchName: $(escapedBranchName)"
echo "Sha: $(sha)"
echo "ShortSha: $(shortSha)"
echo "NuGetVersionV2: $(nuGetVersionV2)"
echo "NuGetVersion: $(nuGetVersion)"
echo "NuGetPreReleaseTagV2: $(nuGetPreReleaseTagV2)"
echo "NuGetPreReleaseTag: $(nuGetPreReleaseTag)"
echo "VersionSourceSha: $(versionSourceSha)"
echo "CommitsSinceVersionSource: $(commitsSinceVersionSource)"
echo "CommitsSinceVersionSourcePadded: $(commitsSinceVersionSourcePadded)"
echo "UncommittedChanges: $(uncommittedChanges)"
echo "CommitDate: $(commitDate)"
- displayName: Display GitVersion variables (with prefix)
script: |
echo "Major: $(GitVersion_Major)"
echo "Minor: $(GitVersion_Minor)"
echo "Patch: $(GitVersion_Patch)"
echo "PreReleaseTag: $(GitVersion_PreReleaseTag)"
echo "PreReleaseTagWithDash: $(GitVersion_PreReleaseTagWithDash)"
echo "PreReleaseLabel: $(GitVersion_PreReleaseLabel)"
echo "PreReleaseNumber: $(GitVersion_PreReleaseNumber)"
echo "WeightedPreReleaseNumber: $(GitVersion_WeightedPreReleaseNumber)"
echo "BuildMetaData: $(GitVersion_BuildMetaData)"
echo "BuildMetaDataPadded: $(GitVersion_BuildMetaDataPadded)"
echo "FullBuildMetaData: $(GitVersion_FullBuildMetaData)"
echo "MajorMinorPatch: $(GitVersion_MajorMinorPatch)"
echo "SemVer: $(GitVersion_SemVer)"
echo "LegacySemVer: $(GitVersion_LegacySemVer)"
echo "LegacySemVerPadded: $(GitVersion_LegacySemVerPadded)"
echo "AssemblySemVer: $(GitVersion_AssemblySemVer)"
echo "AssemblySemFileVer: $(GitVersion_AssemblySemFileVer)"
echo "FullSemVer: $(GitVersion_FullSemVer)"
echo "InformationalVersion: $(GitVersion_InformationalVersion)"
echo "BranchName: $(GitVersion_BranchName)"
echo "EscapedBranchName: $(GitVersion_EscapedBranchName)"
echo "Sha: $(GitVersion_Sha)"
echo "ShortSha: $(GitVersion_ShortSha)"
echo "NuGetVersionV2: $(GitVersion_NuGetVersionV2)"
echo "NuGetVersion: $(GitVersion_NuGetVersion)"
echo "NuGetPreReleaseTagV2: $(GitVersion_NuGetPreReleaseTagV2)"
echo "NuGetPreReleaseTag: $(GitVersion_NuGetPreReleaseTag)"
echo "VersionSourceSha: $(GitVersion_VersionSourceSha)"
echo "CommitsSinceVersionSource: $(GitVersion_CommitsSinceVersionSource)"
echo "CommitsSinceVersionSourcePadded: $(GitVersion_CommitsSinceVersionSourcePadded)"
echo "UncommittedChanges: $(GitVersion_UncommittedChanges)"
echo "CommitDate: $(GitVersion_CommitDate)"
- task: DotNetCoreCLI@2 - task: DotNetCoreCLI@2
displayName: Pack Example displayName: Pack Example
inputs: inputs:
command: pack command: pack
packagesToPack: src/Example/LibExample.csproj packagesToPack: src/Example/LibExample.csproj
versioningScheme: byEnvVar versioningScheme: byEnvVar
versionEnvVar: GitVersion.NuGetVersion # alternative syntax GITVERSION_NUGETVERSION (the former gets converted into the latter internally) versionEnvVar: GitVersion_SemVer # alternative syntax GITVERSION_SEMVER (the former gets converted into the latter internally)
``` ```
### Example 7 ### Example 7
Calculate the version for the build and use the `GitVersion.BranchName` variable in a condition for starting another job. Calculate the version for the build and use the `GitVersion_BranchName` variable in a condition for starting another job.
```yaml ```yaml
jobs: jobs:
@@ -237,13 +346,13 @@ jobs:
name: Version # the step MUST be named to access its output variables in another job. name: Version # the step MUST be named to access its output variables in another job.
- job: CreateReleaseNotes - 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 dependsOn: CalculateVersion
``` ```
### Example 8 ### Example 8
Calculate the version for the build and map the `GitVersion.SemVer` variable into a variable in another job. Calculate the version for the build and map the `GitVersion_SemVer` variable into a variable in another job.
```yaml ```yaml
jobs: jobs:
@@ -258,7 +367,7 @@ jobs:
- job: BuildAndPack - job: BuildAndPack
variables: variables:
Ver.MajorMinorPatch: $[ dependencies.CalculateVersion.outputs['Version.GitVersion.MajorMinorPatch'] ] Ver.MajorMinorPatch: $[ dependencies.CalculateVersion.outputs['Version.GitVersion_MajorMinorPatch'] ]
``` ```
### Example 9 ### Example 9
@@ -279,7 +388,7 @@ stages:
name: Version # the step MUST be named to access its output variables in another stage. name: Version # the step MUST be named to access its output variables in another stage.
- stage: S2 - stage: S2
condition: and(succeeded(), gt(dependencies.S1.outputs['CalculateVersion.Version.GitVersion.Major'], 0)) condition: and(succeeded(), gt(dependencies.S1.outputs['CalculateVersion.Version.GitVersion_Major'], 0))
dependsOn: S1 dependsOn: S1
``` ```
@@ -304,5 +413,5 @@ stages:
jobs: jobs:
- job: UpdateAssemblyVersions - job: UpdateAssemblyVersions
variables: variables:
Ver.AssemblyVer: $[ stageDependencies.S1.CalculateVersion.outputs['Version.GitVersion.AssemblySemVer'] ] # Note the 'stageDependencies.<jobName>' syntax. Ver.AssemblyVer: $[ stageDependencies.S1.CalculateVersion.outputs['Version.GitVersion_AssemblySemVer'] ] # Note the 'stageDependencies.<jobName>' syntax.
``` ```

132
docs/examples/github/gitversion/execute/usage-examples.md
View File

@@ -60,12 +60,12 @@ The Execute GitVersion action creates the following outputs:
- preReleaseNumber - preReleaseNumber
- weightedPreReleaseNumber - weightedPreReleaseNumber
- buildMetaData - buildMetaData
- buildMetaDataPadded - buildMetaDataPadded (removed in 6.0.0)
- fullBuildMetaData - fullBuildMetaData
- majorMinorPatch - majorMinorPatch
- semVer - semVer
- legacySemVer - legacySemVer (removed in 6.0.0)
- legacySemVerPadded - legacySemVerPadded (removed in 6.0.0)
- assemblySemVer - assemblySemVer
- assemblySemFileVer - assemblySemFileVer
- fullSemVer - fullSemVer
@@ -74,19 +74,19 @@ The Execute GitVersion action creates the following outputs:
- escapedBranchName (since 5.2.0) - escapedBranchName (since 5.2.0)
- sha - sha
- shortSha - shortSha
- nuGetVersionV2 - nuGetVersionV2 (removed in 6.0.0)
- nuGetVersion - nuGetVersion (removed in 6.0.0)
- nuGetPreReleaseTagV2 - nuGetPreReleaseTagV2 (removed in 6.0.0)
- nuGetPreReleaseTag - nuGetPreReleaseTag (removed in 6.0.0)
- versionSourceSha - versionSourceSha
- commitsSinceVersionSource - commitsSinceVersionSource
- commitsSinceVersionSourcePadded (since 5.2.0) - commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0)
- uncommittedChanges (since 5.5.0) - uncommittedChanges (since 5.5.0)
- commitDate - commitDate
The outputs can be accessed using the syntax `${{ steps.<id>.outputs.<outputName> }}`, where `<id>` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. See example [5](#example-5). The outputs can be accessed using the syntax `${{ steps.<id>.outputs.<outputName> }}` or `${{ steps.<id>.outputs.GitVersion_<OutputName> }}`, where `<id>` is the ID assigned to the step that calls the action, by subsequent steps later in the same job. See example [5](#example-5).
The action also creates environment variables of the form `GITVERSION_<OUTPUTNAME>` for use by other steps in the same job. See example [6](#example-6). The action also creates environment variables of the form `${{ env.<outputName> }}` or `${{ env.GitVersion_<OutputName> }}` for use by other steps in the same job. See example [6](#example-6).
The outputs can be accessed across jobs by mapping them to job outputs and referencing the job outputs using the `needs` context in dependent jobs. See examples [7](#example-7) and [8](#example-8). The outputs can be accessed across jobs by mapping them to job outputs and referencing the job outputs using the `needs` context in dependent jobs. See examples [7](#example-7) and [8](#example-8).
@@ -168,10 +168,10 @@ steps:
# gitversion/setup@v0 action omitted for brevity. # gitversion/setup@v0 action omitted for brevity.
- name: Determine Version - name: Determine Version
id: gitversion id: gitversion # id to later be referenced
uses: gittools/actions/gitversion/execute@v0 uses: gittools/actions/gitversion/execute@v0
- name: Display GitVersion outputs - name: Display GitVersion outputs (step output)
run: | run: |
echo "Major: ${{ steps.gitversion.outputs.major }}" echo "Major: ${{ steps.gitversion.outputs.major }}"
echo "Minor: ${{ steps.gitversion.outputs.minor }}" echo "Minor: ${{ steps.gitversion.outputs.minor }}"
@@ -205,11 +205,46 @@ steps:
echo "CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.commitsSinceVersionSourcePadded }}" echo "CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.commitsSinceVersionSourcePadded }}"
echo "UncommittedChanges: ${{ steps.gitversion.outputs.uncommittedChanges }}" echo "UncommittedChanges: ${{ steps.gitversion.outputs.uncommittedChanges }}"
echo "CommitDate: ${{ steps.gitversion.outputs.commitDate }}" echo "CommitDate: ${{ steps.gitversion.outputs.commitDate }}"
- name: Display GitVersion outputs (step output with prefix)
run: |
echo "Major: ${{ steps.gitversion.outputs.GitVersion_Major }}"
echo "Minor: ${{ steps.gitversion.outputs.GitVersion_Minor }}"
echo "Patch: ${{ steps.gitversion.outputs.GitVersion_Patch }}"
echo "PreReleaseTag: ${{ steps.gitversion.outputs.GitVersion_PreReleaseTag }}"
echo "PreReleaseTagWithDash: ${{ steps.gitversion.outputs.GitVersion_PreReleaseTagWithDash }}"
echo "PreReleaseLabel: ${{ steps.gitversion.outputs.GitVersion_PreReleaseLabel }}"
echo "PreReleaseNumber: ${{ steps.gitversion.outputs.GitVersion_PreReleaseNumber }}"
echo "WeightedPreReleaseNumber: ${{ steps.gitversion.outputs.GitVersion_WeightedPreReleaseNumber }}"
echo "BuildMetaData: ${{ steps.gitversion.outputs.GitVersion_BuildMetaData }}"
echo "BuildMetaDataPadded: ${{ steps.gitversion.outputs.GitVersion_BuildMetaDataPadded }}"
echo "FullBuildMetaData: ${{ steps.gitversion.outputs.GitVersion_FullBuildMetaData }}"
echo "MajorMinorPatch: ${{ steps.gitversion.outputs.GitVersion_MajorMinorPatch }}"
echo "SemVer: ${{ steps.gitversion.outputs.GitVersion_SemVer }}"
echo "LegacySemVer: ${{ steps.gitversion.outputs.GitVersion_LegacySemVer }}"
echo "LegacySemVerPadded: ${{ steps.gitversion.outputs.GitVersion_LegacySemVerPadded }}"
echo "AssemblySemVer: ${{ steps.gitversion.outputs.GitVersion_AssemblySemVer }}"
echo "AssemblySemFileVer: ${{ steps.gitversion.outputs.GitVersion_AssemblySemFileVer }}"
echo "FullSemVer: ${{ steps.gitversion.outputs.GitVersion_FullSemVer }}"
echo "InformationalVersion: ${{ steps.gitversion.outputs.GitVersion_InformationalVersion }}"
echo "BranchName: ${{ steps.gitversion.outputs.GitVersion_BranchName }}"
echo "EscapedBranchName: ${{ steps.gitversion.outputs.GitVersion_EscapedBranchName }}"
echo "Sha: ${{ steps.gitversion.outputs.GitVersion_Sha }}"
echo "ShortSha: ${{ steps.gitversion.outputs.GitVersion_ShortSha }}"
echo "NuGetVersionV2: ${{ steps.gitversion.outputs.GitVersion_NuGetVersionV2 }}"
echo "NuGetVersion: ${{ steps.gitversion.outputs.GitVersion_NuGetVersion }}"
echo "NuGetPreReleaseTagV2: ${{ steps.gitversion.outputs.GitVersion_NuGetPreReleaseTagV2 }}"
echo "NuGetPreReleaseTag: ${{ steps.gitversion.outputs.GitVersion_NuGetPreReleaseTag }}"
echo "VersionSourceSha: ${{ steps.gitversion.outputs.GitVersion_VersionSourceSha }}"
echo "CommitsSinceVersionSource: ${{ steps.gitversion.outputs.GitVersion_CommitsSinceVersionSource }}"
echo "CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.GitVersion_CommitsSinceVersionSourcePadded }}"
echo "UncommittedChanges: ${{ steps.gitversion.outputs.GitVersion_UncommittedChanges }}"
echo "CommitDate: ${{ steps.gitversion.outputs.GitVersion_CommitDate }}"
``` ```
### Example 6 ### Example 6
Calculate the version for the build and display the value of the `GITVERSION_SEMVER` environment variable. Calculate the version for the build and display the value of the `env.GitVersion_SemVer` environment variable.
```yaml ```yaml
steps: steps:
@@ -218,9 +253,76 @@ steps:
- name: Determine Version - name: Determine Version
uses: gittools/actions/gitversion/execute@v0 uses: gittools/actions/gitversion/execute@v0
- name: Display SemVer
- name: Display GitVersion variables (without prefix)
run: | run: |
echo "SemVer: $GITVERSION_SEMVER" echo "Major: ${{ env.major }}"
echo "Minor: ${{ env.minor }}"
echo "Patch: ${{ env.patch }}"
echo "PreReleaseTag: ${{ env.preReleaseTag }}"
echo "PreReleaseTagWithDash: ${{ env.preReleaseTagWithDash }}"
echo "PreReleaseLabel: ${{ env.preReleaseLabel }}"
echo "PreReleaseNumber: ${{ env.preReleaseNumber }}"
echo "WeightedPreReleaseNumber: ${{ env.weightedPreReleaseNumber }}"
echo "BuildMetaData: ${{ env.buildMetaData }}"
echo "BuildMetaDataPadded: ${{ env.buildMetaDataPadded }}"
echo "FullBuildMetaData: ${{ env.fullBuildMetaData }}"
echo "MajorMinorPatch: ${{ env.majorMinorPatch }}"
echo "SemVer: ${{ env.semVer }}"
echo "LegacySemVer: ${{ env.legacySemVer }}"
echo "LegacySemVerPadded: ${{ env.legacySemVerPadded }}"
echo "AssemblySemVer: ${{ env.assemblySemVer }}"
echo "AssemblySemFileVer: ${{ env.assemblySemFileVer }}"
echo "FullSemVer: ${{ env.fullSemVer }}"
echo "InformationalVersion: ${{ env.informationalVersion }}"
echo "BranchName: ${{ env.branchName }}"
echo "EscapedBranchName: ${{ env.escapedBranchName }}"
echo "Sha: ${{ env.sha }}"
echo "ShortSha: ${{ env.shortSha }}"
echo "NuGetVersionV2: ${{ env.nuGetVersionV2 }}"
echo "NuGetVersion: ${{ env.nuGetVersion }}"
echo "NuGetPreReleaseTagV2: ${{ env.nuGetPreReleaseTagV2 }}"
echo "NuGetPreReleaseTag: ${{ env.nuGetPreReleaseTag }}"
echo "VersionSourceSha: ${{ env.versionSourceSha }}"
echo "CommitsSinceVersionSource: ${{ env.commitsSinceVersionSource }}"
echo "CommitsSinceVersionSourcePadded: ${{ env.commitsSinceVersionSourcePadded }}"
echo "UncommittedChanges: ${{ env.uncommittedChanges }}"
echo "CommitDate: ${{ env.commitDate }}"
- name: Display GitVersion variables (with prefix)
run: |
echo "Major: ${{ env.GitVersion_Major }}"
echo "Minor: ${{ env.GitVersion_Minor }}"
echo "Patch: ${{ env.GitVersion_Patch }}"
echo "PreReleaseTag: ${{ env.GitVersion_PreReleaseTag }}"
echo "PreReleaseTagWithDash: ${{ env.GitVersion_PreReleaseTagWithDash }}"
echo "PreReleaseLabel: ${{ env.GitVersion_PreReleaseLabel }}"
echo "PreReleaseNumber: ${{ env.GitVersion_PreReleaseNumber }}"
echo "WeightedPreReleaseNumber: ${{ env.GitVersion_WeightedPreReleaseNumber }}"
echo "BuildMetaData: ${{ env.GitVersion_BuildMetaData }}"
echo "BuildMetaDataPadded: ${{ env.GitVersion_BuildMetaDataPadded }}"
echo "FullBuildMetaData: ${{ env.GitVersion_FullBuildMetaData }}"
echo "MajorMinorPatch: ${{ env.GitVersion_MajorMinorPatch }}"
echo "SemVer: ${{ env.GitVersion_SemVer }}"
echo "LegacySemVer: ${{ env.GitVersion_LegacySemVer }}"
echo "LegacySemVerPadded: ${{ env.GitVersion_LegacySemVerPadded }}"
echo "AssemblySemVer: ${{ env.GitVersion_AssemblySemVer }}"
echo "AssemblySemFileVer: ${{ env.GitVersion_AssemblySemFileVer }}"
echo "FullSemVer: ${{ env.GitVersion_FullSemVer }}"
echo "InformationalVersion: ${{ env.GitVersion_InformationalVersion }}"
echo "BranchName: ${{ env.GitVersion_BranchName }}"
echo "EscapedBranchName: ${{ env.GitVersion_EscapedBranchName }}"
echo "Sha: ${{ env.GitVersion_Sha }}"
echo "ShortSha: ${{ env.GitVersion_ShortSha }}"
echo "NuGetVersionV2: ${{ env.GitVersion_NuGetVersionV2 }}"
echo "NuGetVersion: ${{ env.GitVersion_NuGetVersion }}"
echo "NuGetPreReleaseTagV2: ${{ env.GitVersion_NuGetPreReleaseTagV2 }}"
echo "NuGetPreReleaseTag: ${{ env.GitVersion_NuGetPreReleaseTag }}"
echo "VersionSourceSha: ${{ env.GitVersion_VersionSourceSha }}"
echo "CommitsSinceVersionSource: ${{ env.GitVersion_CommitsSinceVersionSource }}"
echo "CommitsSinceVersionSourcePadded: ${{ env.GitVersion_CommitsSinceVersionSourcePadded }}"
echo "UncommittedChanges: ${{ env.GitVersion_UncommittedChanges }}"
echo "CommitDate: ${{ env.GitVersion_CommitDate }}"
``` ```
### Example 7 ### Example 7