This GitHub Action makes it easy to pull versions from XML files. It can be used in your workflows for other uses such as version validation, version tag management, and more!!

Note VersionMiner is built using C#/NET and runs in a docker container. If the job step for running this action is contained in a job that runs on Windows, you will need to move the step to a job that runs on Ubuntu. You can split up your jobs to fulfill the runs-on requirements of the GitHub action. This can be accomplished by moving the step into its job. You can then route the action step outputs to the job outputs and use them throughout the rest of your workflow.
For more information on step and job outputs, refer to the GitHub documentation links below:

• Defining outputs for jobs
• Setting a step action output parameter

name: Get Version Example

jobs:
  get_version_job:
    runs-on: ubuntu-latest # Cannot use windows
    steps:
    - uses: actions/3

    - name: Get Version From C# Project File
      id: get-version
      uses: KinsonDigital/[email protected]
      with:
      repo-owner: JohnDoe
      repo-name: MyRepo
      repo-token: ${{ secrets.GITHUB_TOKEN }}
      branch-name: main
      file-format: xml # Not case sensitive
      file-path: "MyProject/MyProject.csproj"
      version-keys: Version

    - name: Print Version From File
      id: print-output
      run: echo "${{ steps.get-version.outputs.version }}"

If the XML file had the contents below, the workflow above would print the value 1.2.3 to the GitHub console.

<!--Quick Example - C# Project File-->
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net7.0</TargetFramework>
    <LangVersion>11.0</LangVersion>
    <Version>1.2.3</Version> <!--The version that would be discovered-->
    <FileVersion>0.1.0</FileVersion>
  </PropertyGroup>
</Project>

The action output is a single string value with the name version. Click here to see an example of how to use the output of the action.

Searches for a version but does not fail the workflow if no version is found:

#Example 1 Workflow
- name: Get Version From C# Project File
    uses: KinsonDigital/[email protected]
    with:
        repo-owner: JohnDoe
        repo-name: MyRepo
        repo-token: ${{ secrets.GITHUB_TOKEN }}
        branch-name: main
        file-format: xml # Not case sensitive
        file-path: "${{ github.workspace }}/MyProject/MyProject.csproj"
        version-keys: Version
        fail-when-version-not-found: false

<!--Example 1 - C# Project File-->
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net7.0</TargetFramework>
    <LangVersion>11.0</LangVersion>
    <Version></Version> <!--No value.  Does not fail workflow.-->
  </PropertyGroup>
</Project>

#Example 2 Workflow
- name: Get Version From C# Project File
    uses: KinsonDigital/[email protected]
    with:
        repo-owner: JohnDoe
        repo-name: MyRepo
        repo-token: ${{ secrets.GITHUB_TOKEN }}
        branch-name: main
        file-format: xml # Not case sensitive
        file-path: "MyProject/MyProject.csproj"
        version-keys: "Version,FileVersion"

<!--Example 2 - C# Project File-->
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net7.0</TargetFramework>
    <LangVersion>11.0</LangVersion>
    <Version></Version> <!--No value. Search continues for the FileVersion key-->
    <FileVersion>4.5.6</FileVersion> <!--Key with a value exists so this value is returned-->
  </PropertyGroup>
</Project>

#Example 3 Workflow
- name: Get Version From C# Project File
    uses: KinsonDigital/[email protected]
    with:
        repo-owner: JohnDoe
        repo-name: MyRepo
        repo-token: ${{ secrets.GITHUB_TOKEN }}
        branch-name: main
        file-format: xml # Not case sensitive
        file-path: "MyProject/MyProject.csproj"
        version-keys: VeRSion # Different casing as the XML key below.
        case-sensitive-keys: false # Not required and has a default value of true.

<!--Example 3 - C# Project File-->
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net7.0</TargetFramework>
    <LangVersion>11.0</LangVersion>
    <version>1.2.3</version> <!--Casing does not match but key is still used.-->
  </PropertyGroup>
</Project>

#Example 4 Workflow
- name: Get Version From C# Project File
    uses: KinsonDigital/[email protected]
    with:
        repo-owner: JohnDoe
        repo-name: MyRepo
        repo-token: ${{ secrets.GITHUB_TOKEN }}
        branch-name: ${{ github.ref }} # If the branch was 'my-branch', this value could be 'refs/heads/my-branch'
        file-format: xml # Not case sensitive
        file-path: "MyProject/MyProject.csproj"
        version-keys: version
        trim-start-from-branch: "refs/heads/"