Jakie są najlepsze praktyki korzystania z atrybutów złożenia?

W moim przypadku budujemy produkt, dla którego mamy rozwiązanie Visual Studio, z różnymi komponentami we własnych projektach. Wspólne atrybuty go. W rozwiązaniu jest około 35 projektów i wspólne informacje o montażu (CommonAssemblyInfo.cs), który posiada następujące atrybuty:

[assembly: AssemblyCompany("Company")]
[assembly: AssemblyProduct("Product Name")]
[assembly: AssemblyCopyright("Copyright © 2007 Company")]
[assembly: AssemblyTrademark("Company")]

//This shows up as Product Version in Windows Explorer
//We make this the same for all files in a particular product version. And increment it globally for all projects.
//We then use this as the Product Version in installers as well (for example built using Wix).
[assembly: AssemblyInformationalVersion("0.9.2.0")]

Inne atrybuty, takie jak Assemblytle, AssemblyVersion itp., Dostarczamy na zasadzie montażu. Podczas budowania zespołu zarówno AssemblyInfo.cs i CommonAssemblyInfo.CS są budowane do każdego zespołu. To daje nam najlepsze z obu światów, w których możesz chcieć mieć wspólne atrybuty dla wszystkich projektów i konkretne wartości dla niektórych innych.

Rozwiązanie przedstawione przez @JRoppert jest prawie takie samo, jak to, co robię. Jedyną różnicą jest to, że umieściłem następujące linie w lokalnym AssemblyInfo.plik cs, ponieważ mogą się one różnić w zależności od zestawu:

#if DEBUG
[assembly: AssemblyConfiguration("Debug")]
#else
[assembly: AssemblyConfiguration("Release")]
#endif
[assembly: AssemblyVersion("This is set by build process")]
[assembly: AssemblyFileVersion("This is set by build process")]
[assembly: CLSCompliant(true)]

Używam również (ogólnie) jednej wspólnej informacji o montażu na rozwiązanie, przy założeniu, że jedno rozwiązanie jest pojedynczą linią produktów / produktem do uwalniania. Plik Common assembly info zawiera również:

[assembly: AssemblyInformationalVersion("0.9.2.0")]

Który ustawi wartość "ProductVersion" wyświetlaną przez Windows Explorer.

MSBuild Community Tasks zawiera niestandardowe zadanie o nazwie AssemblyInfo, którego możesz użyć do wygenerowania assemblyinfo.cs. Wymaga to ręcznej edycji plików csproj, ale warto.

Moim zdaniem przy użyciu GlobalAssemblyInfo.cs jest większy problem niż warto, ponieważ musisz zmodyfikować każdy plik projektu i pamiętaj, aby zmodyfikować każdy nowy projekt, a otrzymasz AssemblyInfo.cs domyślnie.

W przypadku zmian globalnych wartości (tj. firmy, produktu itp.) zmiany są zwykle tak rzadkie i proste w zarządzaniu, że nie sądzę, abysucha powinna być brana pod uwagę. Po prostu uruchom następujący skrypt MSBuild (zależny od MSBuild Extension Pack), gdy chcesz ręcznie zmienić wartości we wszystkich projektach jako jednorazową:

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

    <ItemGroup>
        <AllAssemblyInfoFiles Include="..\**\AssemblyInfo.cs" />
    </ItemGroup>

    <Import Project="MSBuild.ExtensionPack.tasks" />

  <Target Name="UpdateAssemblyInfo">
    <Message Text="%(AllAssemblyInfoFiles.FullPath)" />
    <MSBuild.ExtensionPack.Framework.AssemblyInfo 
        AssemblyInfoFiles="@(AllAssemblyInfoFiles)"
        AssemblyCompany="Company"
        AssemblyProduct="Product"
        AssemblyCopyright="Copyright"
        ... etc ...
        />
  </Target>

</Project>

Aby udostępnić plik między wieloma projektami, możesz dodać istniejący plik jako łącze.

Aby to zrobić, Dodaj istniejący plik i kliknij "Dodaj jako łącze" w selektorze plików.Dodaj jako Link http://laurent.etiemble.free.fr/dotclear/images/AddLinkedFile03_tn.png

Jeśli chodzi o to, co umieścić w udostępnionym pliku, sugerowałbym umieszczenie rzeczy, które byłyby współdzielone między zespołami. Takie rzeczy jak Prawa autorskie, firma, może Wersja.

Używanie pojedynczego AseemblyInfo.plik cs dla wielu projektów nie jest zalecany. Plik AssemblyInfo zawiera informacje, które mogą być istotne tylko dla danego złożenia. Dwie najbardziej oczywiste informacje to AssemblyTitle i AssemblyVersion.

Lepszym rozwiązaniem może być użycie pliku targets, który jest obsługiwany przez MSBuild, w celu "wtrysku" atrybutów złożenia do więcej niż jednego projektu.

Jedną z rzeczy, które uznałem za przydatne, jest wygenerowanie elementów AssemblyVersion (etc) poprzez zastosowanie zastępowania tokenów w fazie pre-build.

Używam TortoiseSvn i łatwo jest użyć jego SubWCRev.exe, aby przekształcić szablon AssemblyInfo.wcrev w AssemblyInfo.cs. Odpowiednia linia w szablonie może wyglądać mniej więcej tak:

[assembly: AssemblyVersion("2.3.$WCREV$.$WCMODS?1:0$$WCUNVER?1:0$")]

Trzecim elementem jest numer wersji. Używam czwartego elementu, aby sprawdzić, czy nie zapomniałem zatwierdzić żadnych nowych lub zmienionych plików (czwarty element to 00, jeśli jest Wszystko OK).

Przy okazji, dodaj AssemblyInfo.wcrev do swojej kontroli wersji i zignoruj AssemblyInfo.cs jeśli użyjesz tego.