Added Clang resource directory to the runtime package.

Related: MochiLibraries/Biohazrd#201

Author: PathogenDavid

.github/workflows/ClangSharp.Pathogen.yml

@@ -34,6 +34,7 @@ jobs:
           - os: ubuntu-18.04
             name: Linux
             lib-path: build-linux/lib/libclang.so
+            clang-resource-dir: build-linux/lib/clang/
             build-command: ./build-native.sh
             artifact-name: LlvmBuildOutputs-Linux
     name: Build LLVM - ${{matrix.name}}
@@ -61,10 +62,13 @@ jobs:
         id: cached-llvm
         uses: actions/cache@v2
         with:
-          key: llvm-output-${{runner.os}}-${{steps.llvm.outputs.revision}}
+          # Bumped to -2 to include the Clang resource directory
+          key: llvm-output-${{runner.os}}-${{steps.llvm.outputs.revision}}-2
           # These are the paths of the external files required in ClangSharp.Pathogen.Runtime.csproj
           # (Make sure this is syncronized with "Archive LLVM Outputs" below)
-          path: ${{matrix.lib-path}}
+          path: |
+            ${{matrix.lib-path}}
+            ${{matrix.clang-resource-dir}}
 
       - name: Checkout LLVM
         if: steps.cached-llvm.outputs.cache-hit != 'true'
@@ -116,7 +120,9 @@ jobs:
           name: ${{matrix.artifact-name}}
           if-no-files-found: error
           # The paths listed here must match "Load cached LLVM build outputs" above
-          path: ${{matrix.lib-path}}
+          path: |
+            ${{matrix.lib-path}}
+            ${{matrix.clang-resource-dir}}
 
   build-dotnet:
     name: Build ClangSharp.Pathogen

ClangSharp.Pathogen.Runtime/ClangSharp.Pathogen.Runtime.csproj

@@ -9,6 +9,7 @@
     <LibClangPathogenPathWindows>$(MSBuildThisFileDirectory)../build/bin/libclang.dll</LibClangPathogenPathWindows>
     <LibClangPathogenPathLinux>$(MSBuildThisFileDirectory)../build-linux/lib/libclang.so</LibClangPathogenPathLinux>
     <PathogenExtensionsCppPath>$(MSBuildThisFileDirectory)../external/llvm-project/clang/tools/libclang/PathogenExtensions.cpp</PathogenExtensionsCppPath>
+    <ClangResourceDirectoryPath>$(MSBuildThisFileDirectory)../build-linux/lib/clang/10.0.0/</ClangResourceDirectoryPath>
     <LicenseFilePath>$(MSBuildThisFileDirectory)../external/llvm-project/clang/LICENSE.TXT</LicenseFilePath>
 
     <!-- Package Info -->
@@ -45,11 +46,32 @@
       <Pack>true</Pack>
       <PackagePath>runtimes/linux-x64/native/libclang-pathogen.so</PackagePath>
     </None>
+    <None Include="$(ClangResourceDirectoryPath)**/*" LinkBase="clang-resources" Condition="Exists('$(ClangResourceDirectoryPath)')">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Pack>true</Pack>
+      <!--
+      We use MSBuild to copy the Clang resource directory to the build output of dependents using MSBuild instead of ContentFiles primarily to avoid having them pollute Solution Explorer:
+      https://github.com/NuGet/Home/issues/4856
+      -->
+      <PackagePath>clang-resources/</PackagePath>
+    </None>
+    <None Update="ClangSharp.Pathogen.Runtime.props">
+      <Pack>true</Pack>
+      <!--
+      buildTransitive is required to ensure the resource directory is also copied to indirect dependents
+      We put the props file in both build and buildTransitive for legacy compatibility even though we don't really expect legacy consumers. (IE: Visual Studio 2017)
+      NuGet will only use the one from buildTransitive when it's buildTransitive-aware.
+      https://github.com/NuGet/Home/wiki/Allow-package%2D-authors-to-define-build-assets-transitive-behavior
+      -->
+      <PackagePath>build;buildTransitive</PackagePath>
+    </None>
   </ItemGroup>
   <!-- Error if native runtime needs to be built or llvm-project is missing -->
   <Target Name="_NativeRuntimeChecks" BeforeTargets="Build;Pack">
     <Error Text="PathogenExtensions.cpp is missing, ensure Git submodules are up-to-date." Condition="!Exists('$(PathogenExtensionsCppPath)')" />
     <Error Text="Clang LICENSE.TXT is missing, ensure Git submodules are up-to-date." Condition="!Exists('$(LicenseFilePath)')" />
+    <!-- Check for resource directory on CI builds -->
+    <Error Text="Clang resource directory is missing." Condition="'$(ContinuousIntegrationBuild)' == 'true' and !Exists('$(ClangResourceDirectoryPath)')" />
 
     <PropertyGroup>
       <_AllRuntimesPresent>true</_AllRuntimesPresent>

ClangSharp.Pathogen.Runtime/ClangSharp.Pathogen.Runtime.props

@@ -0,0 +1,5 @@
+<Project>
+  <ItemGroup>
+    <None Include="$(MSBuildThisFileDirectory)../clang-resources/**/*" LinkBase="clang-resources" Visible="false" CopyToOutputDirectory="PreserveNewest" />
+  </ItemGroup>
+</Project>

ClangSharp.Pathogen/ClangSharp.Pathogen.csproj

@@ -21,7 +21,7 @@
       Do not use ReferenceOutputAssembly="false" here even though the reference isn't needed (and ClangSharp.Pathogen.Runtime.dll is essentially empty.)
       The reference to the assembly will be dropped during emit, and this needs to be a normal reference so that the generated NuGet package depends on the ClangSharp.Pathogen.Runtime package.
     -->
-    <ProjectReference Include="..\ClangSharp.Pathogen.Runtime\ClangSharp.Pathogen.Runtime.csproj" />
+    <ProjectReference Include="..\ClangSharp.Pathogen.Runtime\ClangSharp.Pathogen.Runtime.csproj" PrivateAssets="none" />
   </ItemGroup>
   <ItemGroup>
     <None Include="..\LICENSE.txt" Pack="true" PackagePath="" Visible="false" />

tooling/Versioning.props

@@ -75,7 +75,7 @@ These versions may seem obnoxiously verbose, but the build metadata is usually s
     <DevelopmentVersionCacheFilePath>$(MSBuildProjectDirectory)/obj/DevelopmentVersionNumber</DevelopmentVersionCacheFilePath>
 
     <!-- Load the development build version number from the cache -->
-    <DevelopmentVersionNumber Condition="Exists('$(DevelopmentVersionCacheFilePath)')">$([System.IO.File]::ReadAllText(`$(DevelopmentVersionCacheFilePath)`).Trim())</DevelopmentVersionNumber>
+    <DevelopmentVersionNumber Condition="'$(DevelopmentVersionNumber)' == '' and Exists('$(DevelopmentVersionCacheFilePath)')">$([System.IO.File]::ReadAllText(`$(DevelopmentVersionCacheFilePath)`).Trim())</DevelopmentVersionNumber>
 
     <!--
       If there was no cache, generate a new version number