DotNet.ReproducibleBuilds
1.2.25
Prefix Reserved
dotnet add package DotNet.ReproducibleBuilds --version 1.2.25
NuGet\Install-Package DotNet.ReproducibleBuilds -Version 1.2.25
<PackageReference Include="DotNet.ReproducibleBuilds" Version="1.2.25"> <PrivateAssets>all</PrivateAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference>
<PackageVersion Include="DotNet.ReproducibleBuilds" Version="1.2.25" />
<PackageReference Include="DotNet.ReproducibleBuilds"> <PrivateAssets>all</PrivateAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference>
paket add DotNet.ReproducibleBuilds --version 1.2.25
#r "nuget: DotNet.ReproducibleBuilds, 1.2.25"
#addin nuget:?package=DotNet.ReproducibleBuilds&version=1.2.25
#tool nuget:?package=DotNet.ReproducibleBuilds&version=1.2.25
DotNet.ReproducibleBuilds
This repo is a collection of best practices for build reproducibility with MSBuild.
It provides documentation and NuGet packages to simplify build configuration and isolate builds from developer or workstation-specific settings.
DotNet.ReproducibleBuilds nuget package
It's highly recommended that all projects enable these settings, either via adding this package or manually as described here: https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/
This package sets the following properties:
PublishRepositoryUrl
=true
DebugType
=embedded
. You can specifyportable
in your project if you prefer, but you'll need to upload that.snupkg
file too.ContinuousIntegrationBuild
=true
on CI systems
More information on PublishRepositoryUrl
and debugging with Source Link is here.
Usage
Add the following to your Directory.Build.props
file so all projects in your solution have the package added -- use the latest package version.
<ItemGroup>
<PackageReference Include="DotNet.ReproducibleBuilds" Version="1.2.4" PrivateAssets="All"/>
</ItemGroup>
MSBuild 16.10 is required to generate binaries that can be fully reproduced. You'll need Visual Studio 2019 16.10 and/or .NET 5.0.300 SDK. You'll get a warning if you're using a lower version.
Prerelease packages are available on the following NuGet feed:
https://pkgs.dev.azure.com/dotnet/Projects/_packaging/ReproducibleBuilds/nuget/v3/index.json
DotNet.ReproducibleBuilds.Isolated Documentation and nuget package
It's highly recommended that all projects enable these settings, either via adding this package or manually, as described in Documentation/Reproducible-MSBuild.
This package configures a variety of properties and item groups to prevent your build from unintentionally depending on other installed software that's not described by your repo. All build dependencies should come from either the MSBuild SDK you've chosen, or from nuget packages restored from your package feed.
If you check out the same commit with the same SDK version and same nuget feed, you should get the same build result.
Usage
Add the following to the top of your projects or to Directory.Build.props
:
<Sdk Name="DotNet.ReproducibleBuilds.Isolated" Version="1.2.4" />
Tested on MSBuild 16.7 (Latest LTS at time of writing).
Contributing
See CONTRIBUTING.md for information on contributing to this project.
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.
License
This project is licensed with the MIT license.
.NET Foundation
DotNet.ReproducibleBuilds is a .NET Foundation project.
Related Projects
You should take a look at these related projects:
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on DotNet.ReproducibleBuilds:
Package | Downloads |
---|---|
AspireDashboardHelper
A helper library for adding the Aspire Dashboard docker image to your projects. |
GitHub repositories (72)
Showing the top 20 popular GitHub repositories that depend on DotNet.ReproducibleBuilds:
Repository | Stars |
---|---|
dotnet/Silk.NET
The high-speed OpenGL, OpenCL, OpenAL, OpenXR, GLFW, SDL, Vulkan, Assimp, WebGPU, and DirectX bindings library your mother warned you about.
|
|
morelinq/MoreLINQ
Extensions to LINQ to Objects
|
|
elastic/elasticsearch-net
This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic.
|
|
Dotnet-Boxed/Templates
.NET project templates with batteries included, providing the minimum amount of code required to get you going faster.
|
|
oxyplot/oxyplot
A cross-platform plotting library for .NET
|
|
shouldly/shouldly
Should testing for .NET—the way assertions should be!
|
|
JasperFx/marten
.NET Transactional Document DB and Event Store on PostgreSQL
|
|
microsoft/dotnet-podcasts
.NET reference application shown at .NET Conf featuring ASP.NET Core, Blazor, .NET MAUI, Microservices, Orleans, Playwright, and more!
|
|
martinothamar/Mediator
A high performance implementation of Mediator pattern in .NET using source generators.
|
|
Sergio0694/PolySharp
PolySharp provides generated, source-only polyfills for C# language features, to easily use all runtime-agnostic features downlevel. Add a reference, set your C# version to latest and have fun! 🚀
|
|
stryker-mutator/stryker-net
Mutation testing for .NET core and .NET framework!
|
|
microsoft/automatic-graph-layout
A set of tools for graph layout and viewing
|
|
goatcorp/Dalamud
FFXIV plugin framework and API
|
|
SteveDunn/Vogen
A semi-opinionated library which is a source generator and a code analyser. It Source generates Value Objects
|
|
DigDes/SoapCore
SOAP extension for ASP.NET Core
|
|
andrewlock/NetEscapades.EnumGenerators
A source generator for generating fast "reflection" methods for enums
|
|
atifaziz/NCrontab
Crontab for .NET
|
|
Mimetis/Dotmim.Sync
A brand new database synchronization framework, multi platform, multi databases, developed on top of .Net Standard 2.0. https://dotmimsync.readthedocs.io/
|
|
BcryptNet/bcrypt.net
BCrypt.Net - Bringing updates to the original bcrypt package
|
|
inthehand/32feet
Personal Area Networking for .NET. Open source and professionally supported
|
# Changelog
## [1.2.0]
### Added
- [Support for transitive package references](https://github.com/dotnet/reproducible-builds/pull/16) - thanks @meziantou!
- [Add RepositoryBranch package metadata when available in the build environment](https://github.com/dotnet/reproducible-builds/pull/27) - thanks @kzu!
### Removed
- [Remove the automatically provided .NET Framework reference assembly PackageReference, since the SDK provides this already](https://github.com/dotnet/reproducible-builds/pull/33) - thanks @MattKotsenas!