void HandleStandardProperties(IActivityMonitor m)
{
const string sectionName = "StandardProperties";
var section = XCommentSection.FindOrCreate(Document.Root, sectionName, false);
if (section == null)
{
// Removes previously non sectioned property group.
Document.Root.Elements("PropertyGroup")
.Where(e => e.Element("Copyright") != null || e.Element("PublicSign") != null)
.Select(x => x.ClearCommentsBeforeAndNewLineAfter())
.Remove();
section = XCommentSection.FindOrCreate(Document.Root, sectionName, true);
}
var p = new XElement("PropertyGroup",
new XElement("RepositoryUrl", GitFolder.OriginUrl),
new XElement("ProductName", GitFolder.World.FullName),
new XElement("Company", "Signature Code"),
new XElement("Authors", "Signature Code"),
new XElement("Copyright", @"Copyright Signature-Code 2007-$([System.DateTime]::UtcNow.ToString(""yyyy""))"),
new XElement("RepositoryType", "git"),
new XComment("Removes annoying Pack warning: The package version ... uses SemVer 2.0.0 or components of SemVer 1.0.0 that are not supported on legacy clients..."),
new XElement("NoWarn", "NU5105"));
if (!_solutionSpec.NoStrongNameSigning)
{
p.Add(new XElement("AssemblyOriginatorKeyFile", "$(MSBuildThisFileDirectory)SharedKey.snk"),
new XElement("SignAssembly", true),
new XElement("PublicSign", new XAttribute("Condition", " '$(OS)' != 'Windows_NT' "), true));
}
section.SetContent(p);
}
void HandleBasicDefinitions(IActivityMonitor m, bool useCentralPackages)
{
const string sectionName = "BasicDefinitions";
var section = XCommentSection.FindOrCreate(Document.Root, sectionName, false);
if (section == null)
{
// Removes previously non sectioned property group.
Document.Root.Elements("PropertyGroup")
.Where(e => e.Element("IsTestProject") != null ||
e.Element("SharedDir") != null ||
e.Element("SolutionDir") != null ||
e.Element("IsInTestsFolder") != null)
.Select(e => e.ClearCommentsBeforeAndNewLineAfter())
.Remove();
section = XCommentSection.FindOrCreate(Document.Root, sectionName, true);
}
section.StartComment = ": provides simple and useful definitions.";
var propertyGroup = XElement.Parse(
@"<PropertyGroup>
<!-- SolutionDir is defined by Visual Studio, we unify the behavior here. -->
<SolutionDir Condition="" $(SolutionDir) == '' "">$([System.IO.Path]::GetDirectoryName($([System.IO.Path]::GetDirectoryName($(MSBuildThisFileDirectory)))))/</SolutionDir>
<!-- CakeBuild is obsolete: the new standard ContinuousIntegrationBuild should be used. -->
<ContinuousIntegrationBuild Condition="" '$(CakeBuild)' == 'true' "">true</ContinuousIntegrationBuild>
<!-- Always enable Deterministic build. -->
<Deterministic>true</Deterministic>
<!-- Always allow the repository url to appear in the nuget package. -->
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<!-- InformationalVersion is either the Zero version or provided by the CodeCakeBuilder when in CI build). -->
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
<!-- Always embedds the .pdb in the nuget package.
TODO: When using SourceLink, we should follow the guidelines here: https://github.com/dotnet/sourcelink#using-source-link-in-net-projects
(only for packages that are ultimately uploaded to nuget.org). -->
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
</PropertyGroup>");
if (useCentralPackages)
{
propertyGroup.Add(
new XComment(" Using Microsoft.Build.CentralPackageVersions: this avoids the Packages.props at the root of the repository. "),
new XElement("CentralPackagesFile", "$(MSBuildThisFileDirectory)CentralPackages.props"));
}
var itemGroup = XElement.Parse(
@"<!-- This is always good to define the SourceRoot, even if DeterministicSourcePaths is off. -->
<ItemGroup>
<SourceRoot Include=""$(SolutionDir)"" />
</ItemGroup>");
section.SetContent(propertyGroup, itemGroup);
}
void HandleSourceLink(IActivityMonitor m, bool useCentralPackages)
{
if (_solutionSpec.DisableSourceLink)
{
XCommentSection.FindOrCreate(Document.Root, "SourceLink", false)?.Remove();
}
else
{
EnsureSourceLink(m, useCentralPackages);
}
}
public void ApplySettings(IActivityMonitor m)
{
if (_solutionSpec.NoSharedPropsFile)
{
Delete(m);
return;
}
if (!_commonFolder.EnsureDirectory(m))
{
return;
}
var s = _driver.GetSolution(m, false);
if (s == null)
{
return;
}
bool useCentralPackage = s.Projects.Select(p => p.Tag <MSBuildSln.MSProject>())
.Where(p => p != null)
.Any(p => p.UseMicrosoftBuildCentralPackageVersions);
// If Shared.props exists, we make sure there is no xml namespace defined.
if (Document == null)
{
Document = new XDocument(new XElement("Project"));
}
else
{
Document.Root.RemoveAllNamespaces();
}
HandleBasicDefinitions(m, useCentralPackage);
HandleStandardProperties(m);
XCommentSection.FindOrCreate(Document.Root, "ReproducibleBuilds", false)?.Remove();
HandleZeroVersion(m);
HandleGenerateDocumentation(m);
HandleSourceLink(m, useCentralPackage);
Document.Root.Elements("PropertyGroup")
.Where(e => !e.HasElements)
.Select(e => e.ClearCommentsBeforeAndNewLineAfter())
.Remove();
Save(m);
}
void HandleZeroVersion(IActivityMonitor m)
{
// Removes any GenerateAssemblyInfo elements.
Document.Root.Elements("PropertyGroup").Elements("GenerateAssemblyInfo")
.Select(e => e.ClearCommentsBeforeAndNewLineAfter())
.Remove();
var section = XCommentSection.FindOrCreate(Document.Root, "ZeroVersion", true);
section.StartComment = ": When not building from the CI, assemblies always use the ZeroVersion (see CSemVer.InformationalVersion).";
section.SetContent(
XElement.Parse(
@"<PropertyGroup Condition="" '$(ContinuousIntegrationBuild)' != 'true' "">
<Version>0.0.0-0</Version>
<AssemblyVersion>0.0.0</AssemblyVersion>
<FileVersion>0.0.0.0</FileVersion>
<InformationalVersion>0.0.0-0/0000000000000000000000000000000000000000/0001-01-01 00:00:00Z</InformationalVersion>
</PropertyGroup>"));
}
void HandleGenerateDocumentation(IActivityMonitor m)
{
const string sectionName = "GenerateDocumentation";
var section = XCommentSection.FindOrCreate(Document.Root, sectionName, false);
if (section == null)
{
// Removes previously non sectioned property group.
Document.Root.Elements("PropertyGroup")
.Where(e => e.Element("GenerateDocumentationFile") != null)
.Select(x => x.ClearCommentsBeforeAndNewLineAfter())
.Remove();
section = XCommentSection.FindOrCreate(Document.Root, sectionName, true);
}
section.StartComment = ": Default is in Release or during Cake builds (except for projects below Tests/). Each project can override GenerateDocumentationFile property.";
section.SetContent(
XElement.Parse(
@"<PropertyGroup Condition="" '$(IsInTestsFolder)' != 'true' And ('$(ContinuousIntegrationBuild)' == 'true' Or '$(Configuration)' == 'Release') "">
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>"));
}
bool EnsureSourceLink(IActivityMonitor m, bool useCentralPackages)
{
var linkNames = new string[] { null, "GitHub", "GitLab", "Vsts.Git", "Bitbucket.Git", "FileSystem" };
var linkName = linkNames[(int)GitFolder.KnownGitProvider];
if (linkName == null)
{
m.Error($"SourceLink is not supported on {GitFolder} ({GitFolder.KnownGitProvider}).");
return(false);
}
else if (linkName == "FileSystem")
{
m.Info("Sourcelink for a local git repository is not supported.");
return(true);
}
string packageName = $"Microsoft.SourceLink.{linkName}";
const string currentVersion = "1.0.0";
var section = XCommentSection.FindOrCreate(Document.Root, "SourceLink", true);
section.StartComment = ": is enabled only for ContinuousIntegrationBuild build. ";
section.SetContent(
new XElement("ItemGroup", new XAttribute("Condition", " '$(ContinuousIntegrationBuild)' == 'true' "),
new XElement("PackageReference",
new XAttribute("Include", packageName),
useCentralPackages ? null : new XAttribute("Version", currentVersion),
new XAttribute("PrivateAssets", "All")))
);
// Quick and dirty: impacts the Common/CentralPackages.props here.
if (useCentralPackages)
{
var fName = _commonFolder.FolderPath.AppendPart("CentralPackages.props");
var f = FileSystem.GetFileInfo(fName).AsTextFileInfo(ignoreExtension: true);
if (f != null)
{
var d = XDocument.Parse(f.ReadAsText());
bool hasChanged = d.Root.RemoveAllNamespaces();
var link = d.Root.Elements("ItemGroup")
.Elements("PackageReference").FirstOrDefault(e => (string)e.Attribute("Update") == packageName);
if (link == null)
{
hasChanged = true;
link = new XElement("PackageReference",
new XAttribute("Update", packageName),
new XAttribute("Version", currentVersion));
d.Root.EnsureElement("ItemGroup").Add(link);
}
else if ((hasChanged = (string)link.Attribute("Version") != currentVersion))
{
link.SetAttributeValue("Version", currentVersion);
}
if (hasChanged)
{
m.Info($"Updating '{fName}' for {packageName}/{currentVersion}.");
FileSystem.CopyTo(m, d.ToString(), fName);
}
}
}
return(true);
}
