From 879080cd07e054cb7604e1a49b70608fec84d38d Mon Sep 17 00:00:00 2001 From: Matt Kotsenas Date: Thu, 27 Jun 2024 14:39:44 -0700 Subject: [PATCH 1/4] Update README to direct users to install the latest version --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 01b6174..906d531 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Add the following to your `Directory.Build.props` file so all projects in your s ```xml - + ``` @@ -58,7 +58,7 @@ If you check out the same commit with the same SDK version and same nuget feed, Add the following to the top of your projects or to `Directory.Build.props`: ```xml - + ``` Tested on MSBuild 16.7 (Latest LTS at time of writing). From b3e8e0a9bb29c81885ca252c2325da3f65faf1db Mon Sep 17 00:00:00 2001 From: Matt Kotsenas Date: Thu, 27 Jun 2024 14:47:43 -0700 Subject: [PATCH 2/4] Add badges --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 906d531..5e99e23 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # DotNet.ReproducibleBuilds +[![.NET Foundation](https://img.shields.io/badge/.NET%20Foundation-blueviolet.svg)](https://www.dotnetfoundation.org/) +[![Build Status](https://dev.azure.com/dotnet/Projects/_apis/build/status%2FReproducibleBuilds%20-%20CI?branchName=main)](https://dev.azure.com/dotnet/Projects/_build/latest?definitionId=154&branchName=main) +![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds?style=flat&label=DotNet.ReproducibleBuilds) +![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds.Isolated?style=flat&label=DotNet.ReproducibleBuilds.Isolated) + This repo generates a package that enables reproducible builds in a single step, and documents MSBuild settings useful for enabling reproducibility through isolation. This repo documents various MSBuild settings for reproducibilty, and providing two nuget packages for enabling some of these setting. From 4b9a5b3617248ac4c05b54d90161666fe8415e4f Mon Sep 17 00:00:00 2001 From: Matt Kotsenas Date: Thu, 27 Jun 2024 14:57:05 -0700 Subject: [PATCH 3/4] Copy-edit intro --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5e99e23..0de6f78 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,10 @@ ![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds?style=flat&label=DotNet.ReproducibleBuilds) ![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds.Isolated?style=flat&label=DotNet.ReproducibleBuilds.Isolated) -This repo generates a package that enables reproducible builds in a single step, and documents MSBuild settings useful for enabling reproducibility through isolation. - -This repo documents various MSBuild settings for reproducibilty, and providing two nuget packages for enabling some of these setting. - -The packages are: - -- DotNet.ReproducibleBuilds -- DotNet.ReproducibleBuilds.Isolated +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 From 2890bce3654908d6885c13dd35eee70a29993449 Mon Sep 17 00:00:00 2001 From: Matt Kotsenas Date: Thu, 27 Jun 2024 15:11:11 -0700 Subject: [PATCH 4/4] Move NuGet badges into the appropriate README sections --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0de6f78..913fccf 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ [![.NET Foundation](https://img.shields.io/badge/.NET%20Foundation-blueviolet.svg)](https://www.dotnetfoundation.org/) [![Build Status](https://dev.azure.com/dotnet/Projects/_apis/build/status%2FReproducibleBuilds%20-%20CI?branchName=main)](https://dev.azure.com/dotnet/Projects/_build/latest?definitionId=154&branchName=main) -![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds?style=flat&label=DotNet.ReproducibleBuilds) -![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds.Isolated?style=flat&label=DotNet.ReproducibleBuilds.Isolated) This repo is a collection of best practices for build reproducibility with MSBuild. @@ -12,6 +10,9 @@ workstation-specific settings. ## DotNet.ReproducibleBuilds nuget package +[![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds?style=flat&label=DotNet.ReproducibleBuilds)](https://www.nuget.org/packages/DotNet.ReproducibleBuilds) +[![NuGet Downloads](https://img.shields.io/nuget/dt/DotNet.ReproducibleBuilds?style=flat)](https://www.nuget.org/packages/DotNet.ReproducibleBuilds) + 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/ @@ -44,6 +45,9 @@ Prerelease packages are available on the following [NuGet feed](https://dev.azur ## DotNet.ReproducibleBuilds.Isolated Documentation and nuget package +[![NuGet Version](https://img.shields.io/nuget/v/DotNet.ReproducibleBuilds.Isolated?style=flat&label=DotNet.ReproducibleBuilds.Isolated)](https://www.nuget.org/packages/DotNet.ReproducibleBuilds.Isolated) +[![NuGet Downloads](https://img.shields.io/nuget/dt/DotNet.ReproducibleBuilds.Isolated?style=flat)](https://www.nuget.org/packages/DotNet.ReproducibleBuilds.Isolated) + It's highly recommended that all projects enable these settings, either via adding this package or manually, as described in [Documentation/Reproducible-MSBuild](Documentation/Reproducible-MSBuild/README.md).