Skip to content

Updating the repo to use Directory.Build.props/targets files #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 1, 2019
+1,236 −360
Merged

Updating the repo to use Directory.Build.props/targets files #920

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d517ea6
Updating the repo to use Directory.Build.props/targets files
tannergooding May 1, 2019
9b34afb
Adding an InternalsVisibleTo for DynamicProxyGenAssembly2, PublicKeyT…
tannergooding May 28, 2019
811efc4
Removing duplicate includes from the ImageSharp.csproj
tannergooding May 28, 2019
db8d8d0
Updating the .gitattributes file to explicitly list the line endings
tannergooding May 30, 2019
b907610
Removing the ImageSharp.ruleset file, as the one from standards shoul…
tannergooding May 30, 2019
81c9deb
Updating the package version management to use `PackageReference Update`
tannergooding May 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
369 changes: 360 additions & 9 deletions .editorconfig
View file
Open in desktop

Large diffs are not rendered by default.

102 changes: 102 additions & 0 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>

<!--
Directory.Build.props is automatically picked up and imported by
Microsoft.Common.props. This file needs to exist, even if empty so that
files in the parent directory tree, with the same name, are not imported
instead. The import fairly early and only Sdk.props will have been imported
beforehand. We also don't need to add ourselves to MSBuildAllProjects, as
that is done by the file that imports us.
-->

<!-- Default settings that are used by other settings -->
<PropertyGroup>
<BaseArtifactsPath>$(MSBuildThisFileDirectory)artifacts/</BaseArtifactsPath>
<BaseArtifactsPathSuffix>$(ImageSharpProjectCategory)/$(MSBuildProjectName)</BaseArtifactsPathSuffix>
<RepositoryUrl>https://github.com/SixLabors/ImageSharp/</RepositoryUrl>
</PropertyGroup>

<!-- Default settings that explicitly differ from the Sdk.props defaults -->
<PropertyGroup>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<BaseIntermediateOutputPath>$(BaseArtifactsPath)obj/$(BaseArtifactsPathSuffix)/</BaseIntermediateOutputPath>
<DebugType>portable</DebugType>
<DebugType Condition="'$(codecov)' != ''">full</DebugType>
<NullableContextOptions>disable</NullableContextOptions>
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
<SignAssembly>false</SignAssembly>
Copy link
Contributor Author

@tannergooding tannergooding May 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once strong-name signing is enabled, it should just involve:

  • Updating the standards submodule
  • Updating the SixLabors dependencies to the strong-name signed versions
  • Flipping this to true
  • Adding the PublicKey metdata to the InternalsVisibleTo items

<SuppressNETCoreSdkPreviewMessage>true</SuppressNETCoreSdkPreviewMessage>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)' == 'Debug'">
<CheckForOverflowUnderflow>true</CheckForOverflowUnderflow>
</PropertyGroup>

<!-- Default settings that explicitly differ from the Sdk.targets defaults-->
<PropertyGroup>
<Authors>Six Labors and contributors</Authors>
<BaseOutputPath>$(BaseArtifactsPath)bin/$(BaseArtifactsPathSuffix)/</BaseOutputPath>
<Company>Six Labors</Company>
<PackageOutputPath>$(BaseArtifactsPath)pkg/$(BaseArtifactsPathSuffix)/$(Configuration)/</PackageOutputPath>
<Product>SixLabors.ImageSharp</Product>
<VersionPrefix>0.0.1</VersionPrefix>
<VersionPrefix Condition="'$(packageversion)' != ''">$(PackageVersion)</VersionPrefix>
<VersionSuffix></VersionSuffix>
</PropertyGroup>

<!-- Default settings that are otherwise undefined -->
<PropertyGroup>
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)standards/SixLabors.snk</AssemblyOriginatorKeyFile>
<Copyright>Copyright © Six Labors and Contributors</Copyright>
<Features>strict;IOperation</Features>
<HighEntropyVA>true</HighEntropyVA>
<LangVersion>7.3</LangVersion>
<NeutralLanguage>en</NeutralLanguage>
<OverwriteReadOnlyFiles>true</OverwriteReadOnlyFiles>
<PackageIconUrl>https://raw.githubusercontent.com/SixLabors/Branding/master/icons/imagesharp/sixlabors.imagesharp.128.png</PackageIconUrl>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
<RepositoryType>git</RepositoryType>
<RestoreSources>
https://www.myget.org/F/sixlabors/api/v3/index.json;
https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json;
https://api.nuget.org/v3/index.json;
</RestoreSources>
<SixLaborsPublicKey>002400000c8000009400000006020000002400005253413100040000010001000147e6fe6766715eec6cfed61f1e7dcdbf69748a3e355c67e9d8dfd953acab1d5e012ba34b23308166fdc61ee1d0390d5f36d814a6091dd4b5ed9eda5a26afced924c683b4bfb4b3d64b0586a57eff9f02b1f84e3cb0ddd518bd1697f2c84dcbb97eb8bb5c7801be12112ed0ec86db934b0e9a5171e6bb1384b6d2f7d54dfa97</SixLaborsPublicKey>
<UseSharedCompilation>true</UseSharedCompilation>
</PropertyGroup>

<!-- Package versions for package references across all projects -->
<PropertyGroup>
Copy link
Contributor Author

@tannergooding tannergooding May 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Package versions are all listed/managed here. VS won't update these currently (but likely will eventually).

This allows you to ensure that you can upgrade all projects at the same time, easily.

Copy link
Member

@JimBobSquarePants JimBobSquarePants May 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a damn shame the tooling is behind here. What happens when you update a package through the manager?

Copy link
Contributor Author

@tannergooding tannergooding May 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will change the version in the project file directly.

Copy link
Contributor Author

@tannergooding tannergooding May 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to use PackageReference Update="package-name" Version="" rather than the *PackageVersion properties, as suggested on the twitter thread.

It, unfortunately, doesn't work with the UX either (project file will still be directly changed), but it seems a lot "cleaner" way of doing this.

<BenchmarkDotNetPackageVersion>0.11.5</BenchmarkDotNetPackageVersion>
<ColourfulPackageVersion>2.0.2</ColourfulPackageVersion>
<DotnetXUnitPackageVersion>2.3.1</DotnetXUnitPackageVersion>
<MagicNetQ16AnyCpuPackageVersion>7.12.0</MagicNetQ16AnyCpuPackageVersion>
<MicrosoftNetCompilersToolsetPackageVersion>3.1.0-beta2-final</MicrosoftNetCompilersToolsetPackageVersion>
<MicrosoftNetTestSdkPackageVersion>15.9.0</MicrosoftNetTestSdkPackageVersion>
<MoqPackageVersion>4.10.0</MoqPackageVersion>
<SixLaborsCorePackageVersion>1.0.0-dev000101</SixLaborsCorePackageVersion>
<SixLaborsFontsPackageVersion>1.0.0-beta0008</SixLaborsFontsPackageVersion>
<SixLaborsShapesTextPackageVersion>1.0.0-beta0007</SixLaborsShapesTextPackageVersion>
<SixLaborsShapesPackageVersion>1.0.0-beta0008</SixLaborsShapesPackageVersion>
<StyleCopAnalyzersPackageVersion>1.1.118</StyleCopAnalyzersPackageVersion>
<SystemDrawingCommonPackageVersion>4.5.1</SystemDrawingCommonPackageVersion>
<SystemIOCompressionPackageVersion>4.3.0</SystemIOCompressionPackageVersion>
<SystemIOUnmanagedMemoryStreamPackageVersion>4.3.0</SystemIOUnmanagedMemoryStreamPackageVersion>
<SystemRuntimeCompilerServicesUnsafePackageVersion>4.5.1</SystemRuntimeCompilerServicesUnsafePackageVersion>
<SystemThreadingTasksParallelPackageVersion>4.3.0</SystemThreadingTasksParallelPackageVersion>
<SystemValueTuplePackageVersion>4.5.0</SystemValueTuplePackageVersion>
<XUnitPackageVersion>2.3.1</XUnitPackageVersion>
<XUnitRunnerConsolePackageVersion>2.3.1</XUnitRunnerConsolePackageVersion>
<XUnitRunnerVisualStudioPackageVersion>2.3.1</XUnitRunnerVisualStudioPackageVersion>
</PropertyGroup>

<!-- Package references which are consumed by all projects -->
<ItemGroup>
<PackageReference Include="Microsoft.Net.Compilers.Toolset" Version="$(MicrosoftNetCompilersToolsetPackageVersion)" IsImplicitlyDefined="true" />
Copy link
Contributor Author

@tannergooding tannergooding May 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the Roslyn compiler toolset and ensures all machines build with the same compiler version, regardless of what is on the box.

IsImplicitlyDefined=true just means users can't remove this from the list of NuGet packages in the UX.

Copy link
Member

@JimBobSquarePants JimBobSquarePants May 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL

</ItemGroup>

</Project>
18 changes: 18 additions & 0 deletions Directory.Build.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>

<!--
Directory.Build.targets is automatically picked up and imported by
Microsoft.Common.targets. This file needs to exist, even if empty so that
files in the parent directory tree, with the same name, are not imported
instead. The import fairly late and most other props/targets will have been
imported beforehand. We also don't need to add ourselves to
MSBuildAllProjects, as that is done by the file that imports us.
-->

<!-- Settings that append the existing setting value -->
<PropertyGroup>
<DefineConstants>$(DefineConstants);$(OS)</DefineConstants>
</PropertyGroup>

</Project>
Loading