A GitHub action to update or bump project versions. Supports .csproj, .props, .nuspec, and many other .NET file types.

Supported file types:

• C#:
  • .csproj (.NET / .NET Core projects)
  • .cs (.NET Framework AssemblyInfo files, e.g. AssemblyInfo.cs)
• Visual Basic:
  • .vbproj (.NET / .NET Core projects)
  • .vb (.NET Framework AssemblyInfo files, e.g. AssemblyInfo.vb)
• F#:
  • .fsproj (.NET / .NET Core projects)
  • .fs (.NET Framework AssemblyInfo files, e.g. AssemblyInfo.fs)
• C++/CLI:
  • .cpp (.NET / .NET Core / .NET Framework AssemblyInfo files, e.g. AssemblyInfo.cpp)
  • .rc (C++ resource files; also works for non-.NET C++ projects)
• MSBuild:
  • .props (shared project properties)
• Nuget:
  • .nuspec (Nuget package specs)

Project file paths.

Can be either:

• path to a single project file: "src/MyProject.csproj";
• path pattern: "src/**/*.csproj";
• comma-separated list of path patterns: "src/**/*.csproj", "src/**/*.nuspec", "!src/**/Test"

See fast-glob package documentation for more examples of supported file path patterns.

The new version for the project file.

Can be either:

• explicit version: e.g. 1.2.3 or 1.0.0-beta5;
• one of the bump commands:
  • bump-major;
  • bump-minor;
  • bump-build;
  • bump-revision;
• bump pattern: e.g. *.^.0.? where:
  • ? instructs to leave this version part unchanged;
  • * instructs to leave this version part unchanged or to set it to zero if it doesn't exist;
  • ^ instructs to bump this version part;
  • number instructs to overwrite this version part with the specified number;
  • missing part instructs to remove it from the version if it exists.

Examples:

The version found in the project file before the update. In case of multiple project files, this will be the version found in the last project file.

Example: 1.3.5

The version set by the action during the update. In case of multiple project files, this will be the version written into the last project file.

Example: 1.3.6

name: Manual version update

on:
  workflow_dispatch:
    inputs:
      version:
        description: "New version for the project"
        required: true 
        type: string

jobs:
  update:
    runs-on: ubuntu-latest
    name: Update version
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set MyProject.csproj version
        id: update
        uses: vers-one/[email protected]
        with:
          file: "src/MyProject.csproj"
          version: ${{ github.event.inputs.version }}

      - run: |
          git config user.name "Your Name"
          git config user.email "[email protected]"
          git add .
          git commit -m "Update project version to ${{ steps.update.outputs.newVersion }}"
          git push

name: Manual version update

on:
  workflow_dispatch:
    inputs:
      version:
        description: "New version for all projects"
        required: true 
        type: string

jobs:
  update:
    runs-on: ubuntu-latest
    name: Update versions
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set project versions
        id: update
        uses: vers-one/[email protected]
        with:
          file: |
            "**/*.csproj", "**/*.nuspec", "**/AssemblyInfo.cs"
          version: ${{ github.event.inputs.version }}

      - run: |
          git config user.name "Your Name"
          git config user.email "[email protected]"
          git add .
          git commit -m "Update project versions to ${{ steps.update.outputs.newVersion }}"
          git push

name: Bump build version

on:
  push:
    branches: [ main ]

jobs:
  bump:
    runs-on: ubuntu-latest
    name: Build and bump version
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install .NET 7
        uses: actions/setup-dotnet@v3
        with:
          dotnet-version: 7

      - name: Restore dependencies
        run: dotnet restore

      - name: Build
        run: dotnet build

      - name: Bump build version
        id: bump
        uses: vers-one/[email protected]
        with:
          file: "src/MyProject.csproj"
          version: bump-build

      - run: |
          git config user.name "Your Name"
          git config user.email "[email protected]"
          git add .
          git commit -m "Bump project version to ${{ steps.bump.outputs.newVersion }}"
          git push

• This action searches for the following version declarations:
  • for .csproj, .vbproj, .fsproj, .props, and .nuspec files:
    • <Version>...</Version>;
    • <AssemblyVersion>...</AssemblyVersion>;
    • <FileVersion>...</FileVersion>;
  • for .cs files:
    • [assembly: AssemblyVersion("...")];
    • [assembly: AssemblyFileVersion("...")];
  • for .vb files:
    • <Assembly: AssemblyVersion("...")>;
    • <Assembly: AssemblyFileVersion("...")>;
  • for .fs files:
    • [<assembly: AssemblyVersion("...")>];
    • [<assembly: AssemblyFileVersion("...")>];
  • for .cpp files:
    • [assembly:AssemblyVersionAttribute(L"...")];
    • [assembly:AssemblyFileVersionAttribute(L"...")];
  • for .rc files:
    • FILEVERSION x,x,x,x;
    • PRODUCTVERSION x,x,x,x;
    • VALUE "FileVersion", "..."
    • VALUE "ProductVersion", "...".
• If you set the new version explicitly, you can use any string as a version number (e.g. 1.2.3, 1.0.0-beta5, Vista, blah-blah, etc). However if you use one of the bump commands or a bump pattern, the existing version must by in the following format: major[.minor[.build[.revision]]].
• Keep in mind that .NET Framework assembly versions must be in the following format: major.minor[.build[.revision]]. Any other versions formats like 1.0.0-beta5 will cause a compilation failure.
• C++ resource files require FILEVERSION and PRODUCTVERSION resource parameters to have all four version components (major.minor.build.revision).