From 6301eefbc346b9ef00ede83ce223d8240b71942a Mon Sep 17 00:00:00 2001
From: William Godbe <wigodbe@microsoft.com>
Date: Thu, 19 Mar 2020 12:27:28 -0700
Subject: [PATCH] Add comments cautioning against changing
 DeveloperCertificates.XPlat (#19923)

* Add comments cautioning against changing DeveloperCertificates.XPlat

* Fix bad comment ending
---
 eng/Publishing.props                                          | 1 +
 .../Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj   | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/eng/Publishing.props b/eng/Publishing.props
index 74434eeea5..ab7456c178 100644
--- a/eng/Publishing.props
+++ b/eng/Publishing.props
@@ -34,6 +34,7 @@
     <!-- 
       This target is defined in eng/targets/Packaging.targets and included in every C# and F# project.
       We use Microsoft.AspNetCore.DeveloperCertificates.XPlat because it is a nonshipping package, and we need a non-stable version string to use as our publish location.
+      If Microsoft.AspNetCore.DeveloperCertificates.XPlat ever becomes a shipping package, this logic will break, so be careful
     -->
     <MSBuild Projects="$(RepoRoot)src\Tools\FirstRunCertGenerator\src\Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj"
         Targets="_GetPackageVersionInfo"
diff --git a/src/Tools/FirstRunCertGenerator/src/Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj b/src/Tools/FirstRunCertGenerator/src/Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj
index 353cc6750e..58dc14746e 100644
--- a/src/Tools/FirstRunCertGenerator/src/Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj
+++ b/src/Tools/FirstRunCertGenerator/src/Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj
@@ -7,6 +7,10 @@
     <PackageTags>aspnet;cli</PackageTags>
 
     <!-- This package contains API for the .NET CLI to generate the aspnet HTTPs dev cert during CLI first-run initialization. -->
+    
+    <!-- Our publishing logic depends on this particular package being NonShipping - if this ever becomes a Shipping project, we will incorrectly calculate the repo's version string,
+         which will cause us to publish installers & checksums to the wrong place. If this ever becomes a Shipping project, we also need to update the following line to reference a different NonShipping project:
+         https://github.com/dotnet/aspnetcore/blob/99c9b8ace1d1d916109882d3f983a26ea4e9b66a/eng/Publishing.props#L38 -->
     <IsShippingPackage>false</IsShippingPackage>
     <HasReferenceAssembly>false</HasReferenceAssembly>
     <ExcludeFromSourceBuild>false</ExcludeFromSourceBuild>