More refinements (#277)

* Do dotnet tool restore in targets file * Ensure formatting * At least 7 on build machines * dont format so often * debug ci part 1 * debug ci part 1 * debug ci part 1 * Allow for release/debug builds
TheAngryByrd · Sep 17, 2023 · 39a832d · 39a832d
1 parent 807cdfd
commit 39a832d
Show file tree

Hide file tree

Showing 19 changed files with 299 additions and 247 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,7 +11,9 @@ on:
 jobs:
   build:
     strategy:
+      fail-fast: false
       matrix:
+        configuration: [Debug, Release]
         os: [ubuntu-latest, windows-latest, macOS-latest]
     runs-on: ${{ matrix.os }}
 
@@ -23,16 +25,19 @@ jobs:
           global-json-file: global.json
           dotnet-version: |
             6.x
+            7.x
 
       - name: Build via Bash
         if: runner.os != 'Windows'
         run: |
           chmod +x ./build.sh
           ./build.sh IntegrationTests
         env:
+          CONFIGURATION: ${{ matrix.configuration }}
           CI: true
       - name: Build via Windows
         if: runner.os == 'Windows'
         run: ./build.cmd IntegrationTests
         env:
+          CONFIGURATION: ${{ matrix.configuration }}
           CI: true
diff --git a/Content/Console/.github/workflows/build.yml b/Content/Console/.github/workflows/build.yml
@@ -17,6 +17,7 @@ jobs:
   build:
     strategy:
       matrix:
+        configuration: [Debug, Release]
         os: [ubuntu-latest, windows-latest, macOS-latest]
     runs-on: ${{ matrix.os }}
 
@@ -29,6 +30,7 @@ jobs:
         with:
           dotnet-version: |
             6.x
+            7.x
           global-json-file: global.json
 
       - name: Build
@@ -39,11 +41,13 @@ jobs:
           chmod +x ./build.sh
           ./build.sh
         env:
+          CONFIGURATION: ${{ matrix.configuration }}
           CI: true
       - name: Build
         if: runner.os == 'Windows'
         run: |
           dotnet --info
           ./build.cmd
         env:
+          CONFIGURATION: ${{ matrix.configuration }}
           CI: true
diff --git a/Content/Console/Directory.Build.props b/Content/Console/Directory.Build.props
@@ -1,14 +1,17 @@
+<!--
+This file allows overriding of properties for all projects in the directory.
+See https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022#directorybuildprops-and-directorybuildtargets
+-->
+
 <Project>
     <PropertyGroup>
-        <!-- summary is not migrated from project.json, but you can use the <Description> property for that if needed. -->
         <PackageTags>f#, fsharp</PackageTags>
         <PackageProjectUrl>https://github.com/MyGithubUsername/MyLib.1</PackageProjectUrl>
         <PackageLicenseUrl>https://github.com/MyGithubUsername/MyLib.1/blob/master/LICENSE.md</PackageLicenseUrl>
         <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
         <RepositoryType>git</RepositoryType>
         <Authors>MyGithubUsername</Authors>
         <RepositoryUrl>https://github.com/MyGithubUsername/MyLib.1</RepositoryUrl>
-        <!-- owners is not supported in MSBuild -->
     </PropertyGroup>
     <PropertyGroup>
         <GenerateAssemblyInfo>false</GenerateAssemblyInfo>

diff --git a/Content/Console/Directory.Build.targets b/Content/Console/Directory.Build.targets
@@ -0,0 +1,26 @@
+<!--
+This file allows overriding of properties for all projects in the directory.
+See https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022#directorybuildprops-and-directorybuildtargets
+-->
+<Project>
+
+  <PropertyGroup>
+    <_BuildProjBaseIntermediateOutputPath>$(MSBuildThisFileDirectory)build/obj/</_BuildProjBaseIntermediateOutputPath>
+    <_DotnetToolManifestFile>$(MSBuildThisFileDirectory).config/dotnet-tools.json</_DotnetToolManifestFile>
+    <_DotnetToolRestoreOutputFile>$(_BuildProjBaseIntermediateOutputPath)/dotnet-tool-restore-$(NETCoreSdkVersion)</_DotnetToolRestoreOutputFile>
+    <_DotnetFantomasOutputFile>$(BaseIntermediateOutputPath)dotnet-fantomas-msbuild</_DotnetFantomasOutputFile>
+  </PropertyGroup>
+
+  <!-- Make sure that dotnet tools (including paket) are restored before restoring any project -->
+  <Target Name="ToolRestore" BeforeTargets="Restore;CollectPackageReferences;PaketRestore" Inputs="$(_DotnetToolManifestFile)" Outputs="$(_DotnetToolRestoreOutputFile)">
+    <Exec Command="dotnet tool restore" WorkingDirectory="$(MSBuildThisFileDirectory)" StandardOutputImportance="High" StandardErrorImportance="High" />
+    <MakeDir Directories="$(_BuildProjBaseIntermediateOutputPath)"/>
+    <Touch Files="$(_DotnetToolRestoreOutputFile)" AlwaysCreate="True" ForceTouch="True" />
+  </Target>
+
+  <!-- Make sure that files are formatted before building -->
+  <Target Name="Format" BeforeTargets="BeforeBuild" Inputs="@(Compile)" Outputs="$(_DotnetFantomasOutputFile)" >
+    <Exec Command="dotnet fantomas ." StandardOutputImportance="High" StandardErrorImportance="High" />
+    <Touch Files="$(_DotnetFantomasOutputFile)" AlwaysCreate="True" ForceTouch="True" />
+  </Target>
+</Project>
diff --git a/Content/Console/build.cmd b/Content/Console/build.cmd
@@ -1,4 +1 @@
-echo Restoring dotnet tools...
-dotnet tool restore
-
 dotnet run --project ./build/build.fsproj -- -t %*
diff --git a/Content/Console/build.sh b/Content/Console/build.sh
@@ -3,7 +3,4 @@
 set -eu
 set -o pipefail
 
-echo "Restoring dotnet tools..."
-dotnet tool restore
-
 FAKE_DETAILED_ERRORS=true dotnet run --project ./build/build.fsproj -- -t "$@"
diff --git a/Content/Console/build/build.fs b/Content/Console/build/build.fs
@@ -29,12 +29,20 @@ let environVarAsBoolOrDefault varName defaultValue =
     with _ ->
         defaultValue
 
+
+let isCI = lazy environVarAsBoolOrDefault "CI" false
+
 //-----------------------------------------------------------------------------
 // Metadata and Configuration
 //-----------------------------------------------------------------------------
 
 let productName = "MyLib.1"
 
+
+let rootDirectory =
+    __SOURCE_DIRECTORY__
+    </> ".."
+
 let sln =
     __SOURCE_DIRECTORY__
     </> ".."
@@ -175,16 +183,16 @@ let failOnBadExitAndPrint (p: ProcessResult) =
         failwithf "failed with exitcode %d" p.ExitCode
 
 let rec retryIfInCI times fn =
-    match Environment.environVarOrNone "CI" with
-    | Some _ ->
+    if isCI.Value then
         if times > 1 then
             try
                 fn ()
             with _ ->
                 retryIfInCI (times - 1) fn
         else
             fn ()
-    | _ -> fn ()
+    else
+        fn ()
 
 
 let allReleaseChecks () =
@@ -544,14 +552,15 @@ let githubRelease _ =
     |> GitHub.publishDraft
     |> Async.RunSynchronously
 
+
 let formatCode _ =
-    let result = dotnet.fantomas "."
+    let result = dotnet.fantomas $"{rootDirectory}"
 
     if not result.OK then
         printfn "Errors while formatting all files: %A" result.Messages
 
-let checkFormatCode _ =
-    let result = dotnet.fantomas "--check ."
+let checkFormatCode ctx =
+    let result = dotnet.fantomas $"{rootDirectory} --check"
 
     if result.ExitCode = 0 then
         Trace.log "No files need formatting"
@@ -560,6 +569,7 @@ let checkFormatCode _ =
     else
         Trace.logf "Errors while formatting: %A" result.Errors
 
+
 let initTargets () =
     BuildServer.install [ GitHubActions.Installer ]
 
@@ -635,7 +645,7 @@ let initTargets () =
     ==>! "GitRelease"
 
     "DotnetRestore"
-    ==> "CheckFormatCode"
+    =?> ("CheckFormatCode", isCI.Value)
     ==> "DotnetBuild"
     // ==> "FSharpAnalyzers"
     ==> "DotnetTest"

diff --git a/Content/Library/.github/workflows/build.yml b/Content/Library/.github/workflows/build.yml
@@ -12,6 +12,7 @@ jobs:
   build:
     strategy:
       matrix:
+        configuration: [Debug, Release]
         os: [ubuntu-latest, windows-latest, macOS-latest]
     runs-on: ${{ matrix.os }}
 
@@ -23,6 +24,7 @@ jobs:
           global-json-file: global.json
           dotnet-version: |
             6.x
+            7.x
 
       - name: Build via Bash
         if: runner.os != 'Windows'
@@ -31,10 +33,12 @@ jobs:
           ./build.sh
         env:
           CI: true
+          CONFIGURATION: ${{ matrix.configuration }}
           ENABLE_COVERAGE: true
       - name: Build via Windows
         if: runner.os == 'Windows'
         run: ./build.cmd
         env:
           CI: true
+          CONFIGURATION: ${{ matrix.configuration }}
           ENABLE_COVERAGE: true
diff --git a/Content/Library/Directory.Build.props b/Content/Library/Directory.Build.props
@@ -1,3 +1,9 @@
+
+<!--
+This file allows overriding of properties for all projects in the directory.
+See https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022#directorybuildprops-and-directorybuildtargets
+ -->
+
 <Project>
     <PropertyGroup>
         <PackageTags>f#, fsharp</PackageTags>
@@ -13,7 +19,7 @@
         <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     </PropertyGroup>
     <ItemGroup>
-        <None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="/"/>    
-        <None Include="$(MSBuildThisFileDirectory)LICENSE.md" Pack="true" PackagePath="/"/>    
+        <None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="/"/>
+        <None Include="$(MSBuildThisFileDirectory)LICENSE.md" Pack="true" PackagePath="/"/>
     </ItemGroup>
 </Project>
diff --git a/Content/Library/Directory.Build.targets b/Content/Library/Directory.Build.targets
@@ -0,0 +1,26 @@
+<!--
+This file allows overriding of properties for all projects in the directory.
+See https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022#directorybuildprops-and-directorybuildtargets
+-->
+<Project>
+
+  <PropertyGroup>
+    <_BuildProjBaseIntermediateOutputPath>$(MSBuildThisFileDirectory)build/obj/</_BuildProjBaseIntermediateOutputPath>
+    <_DotnetToolManifestFile>$(MSBuildThisFileDirectory).config/dotnet-tools.json</_DotnetToolManifestFile>
+    <_DotnetToolRestoreOutputFile>$(_BuildProjBaseIntermediateOutputPath)/dotnet-tool-restore-$(NETCoreSdkVersion)</_DotnetToolRestoreOutputFile>
+    <_DotnetFantomasOutputFile>$(BaseIntermediateOutputPath)dotnet-fantomas-msbuild</_DotnetFantomasOutputFile>
+  </PropertyGroup>
+
+  <!-- Make sure that dotnet tools (including paket) are restored before restoring any project -->
+  <Target Name="ToolRestore" BeforeTargets="Restore;CollectPackageReferences;PaketRestore" Inputs="$(_DotnetToolManifestFile)" Outputs="$(_DotnetToolRestoreOutputFile)">
+    <Exec Command="dotnet tool restore" WorkingDirectory="$(MSBuildThisFileDirectory)" StandardOutputImportance="High" StandardErrorImportance="High" />
+    <MakeDir Directories="$(_BuildProjBaseIntermediateOutputPath)"/>
+    <Touch Files="$(_DotnetToolRestoreOutputFile)" AlwaysCreate="True" ForceTouch="True" />
+  </Target>
+
+  <!-- Make sure that files are formatted before building -->
+  <Target Name="Format" BeforeTargets="BeforeBuild" Inputs="@(Compile)" Outputs="$(_DotnetFantomasOutputFile)" >
+    <Exec Command="dotnet fantomas ." StandardOutputImportance="High" StandardErrorImportance="High" />
+    <Touch Files="$(_DotnetFantomasOutputFile)" AlwaysCreate="True" ForceTouch="True" />
+  </Target>
+</Project>
diff --git a/Content/Library/build.cmd b/Content/Library/build.cmd
@@ -1,4 +1 @@
-echo Restoring dotnet tools...
-dotnet tool restore
-
 dotnet run --project ./build/build.fsproj -- -t %*
diff --git a/Content/Library/build.sh b/Content/Library/build.sh
@@ -3,7 +3,4 @@
 set -eu
 set -o pipefail
 
-echo "Restoring dotnet tools..."
-dotnet tool restore
-
 FAKE_DETAILED_ERRORS=true dotnet run --project ./build/build.fsproj -- -t "$@"