Автоматична версія в Visual Studio 2017 (.NET Core)

Я витратив більшу частину кількох годин, намагаючись знайти спосіб автоматичного збільшення версій у .NETCoreApp 1.1 (Visual Studio 2017).

Я знаю, що AssemblyInfo.cs створюється динамічно у папці: obj/Debug/netcoreapp1.1/

Він не приймає старий метод: [assembly: System.Reflection.AssemblyFileVersionAttribute("1.0.0.*")]

Якщо я встановив проект на пакунок, я можу встановити його версії, але це, здається, використовується для створення файлу AssemblyInfo.cs.

Моє запитання: чи хтось придумав, як контролювати версію в проектах .NET Core (або .NETStandard для цього питання).

Я шукав інвертор версій для програми Net Core у VS2017 у форматі конфігурації csproj.

Я знайшов проект під назвою dotnet bump, який працював у форматі project.json, але намагався знайти рішення для формату .csproj. Письменник, натхненник dotnet, фактично придумав рішення для формату .csproj, і це називається MSBump.

Є проект на GitHub для нього за адресою:

https://github.com/BalassaMarton/MSBump

де ви можете побачити код і його доступний і в Nuget. Просто шукайте MSBump на Nuget.

Додати <Deterministic>False</Deterministic> всередину <PropertyGroup>розділу .csproj

Вирішення способу зробити AssemblyVersion * описано у розділі "Помітне повідомлення про помилку для підстановки у [AssemblyVersion] on .Net Core # 22660"

Підстановочні символи дозволені лише в тому випадку, якщо збірка не детермінована, що є типовим для проектів .Net Core. Додавання  <Deterministic>False</Deterministic> до csproj виправляє проблему.

Причини, через які .Net Core Developer вважає детерміновані збірки корисними, описані в http://blog.paranoidcoding.com/2016/04/05/deterministic-builds-in-roslyn.html і компілятори повинні бути детермінованими: одні й ті ж входи генерують однакові результати # 372

Однак якщо ви використовуєте TeamCity, TFS або інший інструмент CI / CD, можливо, краще тримати під контролем та збільшенням версії номер версії та переходити до складання як параметр (як це було запропоновано в інших відповідях), наприклад

msbuild /t:build /p:Version=YourVersionNumber /p:AssemblyVersion=YourVersionNumber

Номер пакета для пакетів NuGet

msbuild /t:pack /p:Version=YourVersionNumber   

Якщо ви використовуєте службу / Visual Studio Team Services / TFS або інший процес збирання CI для вбудованої версії, ви можете використовувати Conditionатрибут msbuild , наприклад:

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <Version Condition=" '$(BUILD_BUILDNUMBER)' == '' ">0.0.1-local</Version>
    <Version Condition=" '$(BUILD_BUILDNUMBER)' != '' ">$(BUILD_BUILDNUMBER)</Version>
    <TargetFramework>netcoreapp1.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <Folder Include="wwwroot\" />
  </ItemGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.0.0" />
    <PackageReference Include="Microsoft.AspNetCore" Version="1.1.2" />
    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="1.1.2" />
  </ItemGroup>

</Project>

Це дозволить компілятору .NET Core використовувати все, що є в BUILD_BUILDNUMBERзмінній оточення, якщо воно є, або резервне, 0.0.1-localякщо ви робите збірку на своїй локальній машині.

Я придумав рішення, яке працювало майже так само, як і старий атрибут AssemblyVersion із зіркою (*) - AssemblyVersion ("1.0. ") *

Значення для AssemblyVersion і AssemblyFileVersion є у файлі .csproj проекту MSBuild (не в AssemblyInfo.cs ) як властивість FileVersion (генерує AssemblyFileVersionAttribute ) і AssemblyVersion (генерує AssemblyVersionAttribute ). У процесі MSBuild ми використовуємо нашу власну задачу MSBuild для генерації номерів версій, а потім переосмислюємо значення цих властивостей FileVersion і AssemblyVersion на нові значення з завдання.

Отже, спочатку ми створимо нашу власну MSBuild завдання GetCurrentBuildVersion :

public class GetCurrentBuildVersion : Task
{
    [Output]
    public string Version { get; set; }
 
    public string BaseVersion { get; set; }
 
    public override bool Execute()
    {
        var originalVersion = System.Version.Parse(this.BaseVersion ?? "1.0.0");
 
        this.Version = GetCurrentBuildVersionString(originalVersion);
 
        return true;
    }
 
    private static string GetCurrentBuildVersionString(Version baseVersion)
    {
        DateTime d = DateTime.Now;
        return new Version(baseVersion.Major, baseVersion.Minor,
            (DateTime.Today - new DateTime(2000, 1, 1)).Days,
            ((int)new TimeSpan(d.Hour, d.Minute, d.Second).TotalSeconds) / 2).ToString();
    }
}

Клас завдань успадковується від Microsoft.Build.Utilities.Task клас з пакету Microsoft.Build.Utilities.Core NuGet. Він бере властивість BaseVersion (необов'язково) при введенні та повертає генеровану версію у вихідному властивості версії. Логіка отримання номерів версій така ж, як і автоматичне оновлення .NET (число збірки - це кількість днів, починаючи з 1/1/2000, а перегляд - півтори секунди з півночі).

Для побудови цього завдання MSBuild ми використовуємо тип проекту для бібліотеки класу .NET Standard 1.3 .

Файл .csproj може виглядати так:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard1.3</TargetFramework>
    <AssemblyName>DC.Build.Tasks</AssemblyName>
    <RootNamespace>DC.Build.Tasks</RootNamespace>
    <PackageId>DC.Build.Tasks</PackageId>
    <AssemblyTitle>DC.Build.Tasks</AssemblyTitle>
  </PropertyGroup>
 
  <ItemGroup>
    <PackageReference Include="Microsoft.Build.Framework" Version="15.1.1012" />
    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="15.1.1012" />
  </ItemGroup>
</Project>

Цей проект завдання також доступний у моїх програмах GitHub holajan / DC.Build.Tasks

Тепер ми налаштовуємо MSBuild для використання цього завдання та встановлюємо властивості FileVersion та AssemblyVersion . У файлі .csproj це виглядає приблизно так:

<Project Sdk="Microsoft.NET.Sdk">
  <UsingTask TaskName="GetCurrentBuildVersion" AssemblyFile="$(MSBuildThisFileFullPath)\..\..\DC.Build.Tasks.dll" />
 
  <PropertyGroup>
    ...
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <FileVersion>1.0.0.0</FileVersion>
  </PropertyGroup>
 
  ...
 
  <Target Name="BeforeBuildActionsProject1" BeforeTargets="BeforeBuild">
    <GetCurrentBuildVersion BaseVersion="$(FileVersion)">
      <Output TaskParameter="Version" PropertyName="FileVersion" />
    </GetCurrentBuildVersion>
    <PropertyGroup>
      <AssemblyVersion>$(FileVersion)</AssemblyVersion>
    </PropertyGroup>
  </Target>
 
</Project>

Тут важливі речі:

• Згадано за допомогою використання імпорту завдань GetCurrentBuildVersion з DC.Build.Tasks.dll . Він передбачає, що цей dll-файл знаходиться в батьківському каталозі з вашого .csproj-файлу.
• Наша передBuildActionsProject1 Завдання, яка має завдання для викликів, повинна мати унікальну назву для кожного проекту, якщо у нас є більше проектів у рішенні, яке викликає завдання GetCurrentBuildVersion.

Перевага цього рішення полягає в тому, що воно працює не тільки з побудов на сервері збірки, але і в ручних побудовах з dotnet build або Visual Studio.

Ви можете використовувати функцію властивості MSBuild, щоб встановити суфікс версії на основі поточної дати:

<PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
  <VersionSuffix>pre$([System.DateTime]::UtcNow.ToString(yyyyMMdd-HHmm))</VersionSuffix>
</PropertyGroup>

Це виведе пакет з назвою типу: PackageName.1.0.0-pre20180807-1711.nupkg .

Детальніше про функції властивості MSBuild: https://docs.microsoft.com/en-us/visualstudio/msbuild/property-functions

VersionФормується з комбінації VersionPrefixі VersionSuffix, або якщо VersionSuffixпорожньо, VersionPrefixтільки.

<PropertyGroup>
  <VersionPrefix>1.0.0</VersionPrefix>
</PropertyGroup>

Я прийняв вищезазначену відповідь, тому що @Gigi правильний (станом на даний час), але я був роздратований і придумав наступні сценарії PowerShell.

Спочатку я маю сценарій у своїй папці рішення (UpdateBuildVersion.ps1):

#Get Path to csproj
$path = "$PSScriptRoot\src\ProjectFolder\ProjectName.csproj"

#Read csproj (XML)
$xml = [xml](Get-Content $path)

#Retrieve Version Nodes
$assemblyVersion = $xml.Project.PropertyGroup.AssemblyVersion
$fileVersion = $xml.Project.PropertyGroup.FileVersion

#Split the Version Numbers
$avMajor, $avMinor, $avBuild  = $assemblyVersion.Split(".")
$fvMajor, $fvMinor, $fvBuild = $fileVersion.Split(".")

#Increment Revision
$avBuild = [Convert]::ToInt32($avBuild,10)+1
$fvBuild = [Convert]::ToInt32($fvBuild,10)+1

#Put new version back into csproj (XML)
$xml.Project.PropertyGroup.AssemblyVersion = "$avMajor.$avMinor.$avBuild"
$xml.Project.PropertyGroup.FileVersion = "$fvMajor.$fvMinor.$fvBuild"

#Save csproj (XML)
$xml.Save($path)

Я додав це до файлу csproj:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <AssemblyVersion>0.0.1</AssemblyVersion>
    <FileVersion>0.0.1</FileVersion>
    <PreBuildEvent>powershell.exe –NonInteractive –ExecutionPolicy Unrestricted -command "& {$(SolutionDir)UpdateBuildVersion.ps1}"</PreBuildEvent>
  </PropertyGroup>
</Project>

Навіть якщо його встановити як PreBuildEvent, факт полягає в тому, що номери версій не оновлюються, поки ПІСЛЯ файл не буде завантажений в пам'ять, тому номер версії не відображатиметься до наступної збірки. Насправді ви можете змінити його на PostBuildEvent, і це матиме той же ефект.

Я також створив такі два сценарії: (UpdateMinorVersion.ps1)

#Get Path to csproj
$path = "$PSScriptRoot\src\ProjectFolder\ProjectName.csproj"

#Read csproj (XML)
$xml = [xml](Get-Content $path)

#Retrieve Version Nodes
$assemblyVersion = $xml.Project.PropertyGroup.AssemblyVersion
$fileVersion = $xml.Project.PropertyGroup.FileVersion

#Split the Version Numbers
$avMajor, $avMinor, $avBuild  = $assemblyVersion.Split(".")
$fvMajor, $fvMinor, $fvBuild = $fileVersion.Split(".")

#Increment Minor Version - Will reset all sub nodes
$avMinor = [Convert]::ToInt32($avMinor,10)+1
$fvMinor = [Convert]::ToInt32($fvMinor,10)+1
$avBuild = 0
$fvBuild = 0

#Put new version back into csproj (XML)
$xml.Project.PropertyGroup.AssemblyVersion = "$avMajor.$avMinor.$avBuild"
$xml.Project.PropertyGroup.FileVersion = "$fvMajor.$fvMinor.$fvBuild"

#Save csproj (XML)
$xml.Save($path)

(UpdateMajorVersion.ps1)

#Get Path to csproj
$path = "$PSScriptRoot\src\ProjectFolder\ProjectName.csproj"

#Read csproj (XML)
$xml = [xml](Get-Content $path)

#Retrieve Version Nodes
$assemblyVersion = $xml.Project.PropertyGroup.AssemblyVersion
$fileVersion = $xml.Project.PropertyGroup.FileVersion

#Split the Version Numbers
$avMajor, $avMinor, $avBuild  = $assemblyVersion.Split(".")
$fvMajor, $fvMinor, $fvBuild = $fileVersion.Split(".")

#Increment Major Version - Will reset all sub nodes
$avMajor = [Convert]::ToInt32($avMajor,10)+1
$fvMajor = [Convert]::ToInt32($fvMajor,10)+1
$avMinor = 0
$fvMinor = 0
$avBuild = 0
$fvBuild = 0

#Put new version back into csproj (XML)
$xml.Project.PropertyGroup.AssemblyVersion = "$avMajor.$avMinor.$avBuild"
$xml.Project.PropertyGroup.FileVersion = "$fvMajor.$fvMinor.$fvBuild"

#Save csproj (XML)
$xml.Save($path)

dotnet build /p:AssemblyVersion=1.2.3.4

Я відповідав: "хтось придумав, як контролювати версію в проектах .NET Core (або .NETStandard для цього питання)." Я знайшов це питання, намагаючись вирішити цю проблему в контексті побудови ІС. Я хотів встановити версію збірки на номер збірки CI.

Ці значення тепер встановлені у .csprojфайлі:

<PropertyGroup>
    <TargetFramework>netcoreapp1.1</TargetFramework>
    <AssemblyVersion>1.0.6.0</AssemblyVersion>
    <FileVersion>1.0.6.0</FileVersion>
    <Version>1.0.1</Version>
</PropertyGroup>

Це ті самі значення, які ви бачите, якщо перейти на вкладку Пакет у налаштуваннях проекту. Хоча я не думаю, що ви можете використовувати *для автоматичного збільшення версії, проте ви можете ввести крок після обробки, який замінює версії для вас (наприклад, як частина вашої постійної інтеграції).

Я зробив простий інструмент CLI для установки .csproj версії рядків .NET Ключовий тут . Ви можете комбінувати його з такими інструментами, як GitVersion, для автоматичного зіткнення версій під час збирання CI, якщо ви цього хочете.

Щоб увімкнути версію вашого .Net Core / .Net Незалежно від проекту на основі налаштування GIT, використовуйте теги / опишіть функціональність GIT.

Я використовував файл Prebuild.targets.xml, який знаходиться в кореневій папці для проекту і включений у файл csproj, як:

<Project Sdk="Microsoft.NET.Sdk">
  <Import Project="PreBuild.targets.xml" />
  ...
  <PropertyGroup>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>

Використовуйте тег "GenerateAssembyInfo", щоб відключити автоматичну генерацію інформації про збірку.

Тоді Prebuild.targets.xml генерує файл CommonAssemblyInfo.cs, куди ви можете включити потрібні теги версій на основі вашої версії GIT

ПРИМІТКА. Я знайшов Prebuilds.targets.xml десь ще, тому не намагався його прибирати.)

Файл Prebuild.targets.xml:

    <?xml version="1.0" encoding="utf-8" ?>
    <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

      <UsingTask
        TaskName="GetVersion"
        TaskFactory="CodeTaskFactory"
        AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >
        <ParameterGroup>
          <VersionString ParameterType="System.String" Required="true" />
          <Version ParameterType="System.String" Output="true" />
          <Commit ParameterType="System.String" Output="true" />
          <VersionSuffix ParameterType="System.String" Output="true" />
        </ParameterGroup>
        <Task>
          <!--<Reference Include="" />-->
          <Using Namespace="System"/>
          <Using Namespace="System.IO"/>
          <Using Namespace="System.Text.RegularExpressions" />
          <Code Type="Fragment" Language="cs">
            <![CDATA[
              var match = Regex.Match(VersionString, @"^(?<major>\d+)\.(?<minor>\d+)(\.?(?<patch>\d+))?-(?<revision>\d+)-(?<commit>[a-z0-9-]+)$");
              int major, minor, patch, revision;
              Int32.TryParse(match.Groups["major"].Value, out major);
              Int32.TryParse(match.Groups["minor"].Value, out minor);
              Int32.TryParse(match.Groups["patch"].Value, out patch);
              Int32.TryParse(match.Groups["revision"].Value, out revision);
              _Version = new Version(major, minor, patch, revision).ToString();
              _Commit = match.Groups["commit"].Value;
            ]]>
          </Code>
        </Task>
      </UsingTask>

      <UsingTask
        TaskName="GitExistsInPath"
        TaskFactory="CodeTaskFactory"
        AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >
        <ParameterGroup>
          <Exists ParameterType="System.Boolean" Output="true" />
        </ParameterGroup>
        <Task>
          <!--<Reference Include="" />-->
          <Using Namespace="System"/>
          <Using Namespace="System.IO"/>
          <Using Namespace="System.Text.RegularExpressions" />
          <Code Type="Fragment" Language="cs">
            <![CDATA[
            var values = Environment.GetEnvironmentVariable("PATH");
            foreach (var path in values.Split(';')) {
                var exeFullPath = Path.Combine(path, "git.exe");
                if (File.Exists(exeFullPath)) {
                    Exists = true;
                    return true;
                }
                var cmdFullPath = Path.Combine(path, "git.cmd");
                if (File.Exists(cmdFullPath)) {
                    Exists = true;
                    return true;
            }
            }
            Exists = false;
            ]]>
          </Code>
        </Task>
      </UsingTask>

      <Target Name="CreateCommonVersionInfo" BeforeTargets="CoreCompile">
        <Message Importance="high" Text="CreateCommonVersionInfo" />

        <GitExistsInPath>
          <Output TaskParameter="Exists" PropertyName="GitExists"/>
        </GitExistsInPath>
        <Message Importance="High" Text="git not found!" Condition="!$(GitExists)"/>

        <Exec Command="git describe --tags --long --dirty > $(ProjectDir)version.txt" Outputs="$(ProjectDir)version.txt" WorkingDirectory="$(SolutionDir)" IgnoreExitCode="true" Condition="$(GitExists)">
          <Output TaskParameter="ExitCode" PropertyName="ExitCode" />
        </Exec>
        <Message Importance="high" Text="Calling git failed with exit code $(ExitCode)" Condition="$(GitExists) And '$(ExitCode)'!='0'" />

        <ReadLinesFromFile File="$(ProjectDir)version.txt" Condition="$(GitExists) And '$(ExitCode)'=='0'">
          <Output TaskParameter="Lines" ItemName="OutputLines"/>
        </ReadLinesFromFile>
        <Message Importance="High" Text="Tags: @(OutputLines)" Condition="$(GitExists) And '$(ExitCode)'=='0'"/>

        <Delete Condition="Exists('$(ProjectDir)version.txt')" Files="$(ProjectDir)version.txt"/>

        <GetVersion VersionString="@(OutputLines)" Condition="$(GitExists) And '$(ExitCode)'=='0'">
          <Output TaskParameter="Version" PropertyName="VersionString"/>
          <Output TaskParameter="Commit" PropertyName="Commit"/>
        </GetVersion>

        <PropertyGroup>
          <VersionString Condition="'$(VersionString)'==''">0.0.0.0</VersionString>
        </PropertyGroup>

        <Message Importance="High" Text="Creating CommonVersionInfo.cs with version $(VersionString) $(Commit)" />

        <WriteLinesToFile Overwrite="true" File="$(ProjectDir)CommonAssemblyInfo.cs" Encoding="UTF-8" Lines='using System.Reflection%3B

    // full version: $(VersionString)-$(Commit)

    [assembly: AssemblyVersion("$(VersionString)")]
    [assembly: AssemblyInformationalVersion("$(VersionString)")] 
    [assembly: AssemblyFileVersion("$(VersionString)")]' />

      </Target>
    </Project>

EDIT: Якщо ви будуєте за допомогою MSBUILD,

 $(SolutionDir)

Можливо, у вас виникнуть неприємності, використовуйте

 $(ProjectDir)

замість цього

Ви можете зробити наступне, у файлі csproj. Я не зрозумів математики. Я виявив, що десь ще в stackoverflow. Але це працює і дасть вам щось подібне до 1,0. * Для версії.

<PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <FileVersion>1.0.$([System.DateTime]::UtcNow.Date.Subtract($([System.DateTime]::Parse("2000-01-01"))).TotalDays).$([System.Math]::Floor($([MSBuild]::Divide($([System.DateTime]::UtcNow.TimeOfDay.TotalSeconds), 1.32))))</FileVersion>
    <Version>1.0.$([System.DateTime]::UtcNow.Date.Subtract($([System.DateTime]::Parse("2000-01-01"))).TotalDays)</Version>
</PropertyGroup>

Розширення Automatic Versions для Visual Studio тепер підтримує автоматичне посилення .Net Core та .Net Standard у простому інтерфейсі користувача.

https://marketplace.visualstudio.com/items?itemName=PrecisionInfinity.AutomaticVersions

Дякую @joelsand за те, що вказав на мене в правильному напрямку.

Мені довелося трохи змінити його відповідь, коли коли запущено DevOps Build, я отримав наступне виняток

The specified version string does not conform to the recommended format - major.minor.build.revision

Мені довелося додати $ (BUILD_BUILDNUMBER) наприкінці розділу major.minor.build. Для видалення дублювання фактичної версії я також використовую префікс версії:

<PropertyGroup>
    <VersionPrefix>1.0.3</VersionPrefix>
    <Version Condition=" '$(BUILD_BUILDNUMBER)' == '' ">$(VersionPrefix)-local</Version>
    <Version Condition=" '$(BUILD_BUILDNUMBER)' != '' ">$(VersionPrefix)-$(BUILD_BUILDNUMBER)</Version>
</PropertyGroup>

Ми можемо використовувати спеціальний параметр для dotnet publish -- version-suffix 1.2.3

Для версії файлу:

<AssemblyVersion Condition=" '$(VersionSuffix)' == '' ">0.0.1.0</AssemblyVersion>
<AssemblyVersion Condition=" '$(VersionSuffix)' != '' ">$(VersionSuffix)</AssemblyVersion>

Для версії:

<Version Condition=" '$(VersionSuffix)' == '' ">0.0.1</Version>
<Version Condition=" '$(VersionSuffix)' != '' ">$(VersionSuffix)</Version>

https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish?tabs=netcore21

--version-suffix <VERSION_SUFFIX>     Defines the value for the $(VersionSuffix) property in the project.

Я думаю, що це відповідь від @joelsand є правильною відповіддю для встановлення номера версії для ядра dotnet, що працює на VSTS

Щоб додати більше інформації для цієї відповіді,

BUILD_BUILDNUMBERнасправді заздалегідь визначена змінна .

Виявляється, є 2 версії заздалегідь визначеної змінної.

Один - build.xxxx, інший - BUILD_XXXX.

Ви можете використовувати лише Environment Variable Nameв cproj.