Make the tool package nicer (ionide#792)

TheAngryByrd · Jun 15, 2021 · 033be20 · 033be20
1 parent 3addc0f
commit 033be20
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 8 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -9,7 +9,7 @@
       ]
     },
     "paket": {
-      "version": "5.257.0",
+      "version": "6.0.0-rc002",
       "commands": [
         "paket"
       ]

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-2019, macos-10.15, ubuntu-20.04]
-        dotnet: [5.0.200]
+        dotnet: [5.0.300]
       fail-fast: false # we have timing issues on some OS, so we want them all to run
 
     runs-on: ${{ matrix.os }}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -16,7 +16,7 @@ jobs:
   release:
     strategy:
       matrix:
-        dotnet: [5.0.200]
+        dotnet: [5.0.300]
 
     runs-on: ubuntu-20.04
 

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -3,7 +3,6 @@
   <PropertyGroup>
     <Title>FsAutoComplete</Title>
     <Product>FsAutoComplete</Product>
-    <Description>A command line tool for interfacing with FSharp.Compiler.Service over a pipe.</Description>
     <PackageLicenseExpression Condition=" '$(PackAsTool)' != 'true' ">Apache-2.0</PackageLicenseExpression>
     <NoWarn>3186</NoWarn><!-- circumvent an error with the fake dependencymanager for paket: https://github.com/dotnet/fsharp/issues/8678 -->
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>

diff --git a/build.fsx b/build.fsx
@@ -66,6 +66,10 @@ Target.create "ReleaseArchive" (fun _ ->
     |> Shell.copy "bin/pkgs"
 )
 
+let versionProp = "Version", release.AssemblyVersion
+let packAsToolProp = "PackAsTool", "true"
+let latestReleaseNotesProp = "PackageReleaseNotes", release.Notes |> String.concat "\n"
+
 Target.create "LocalRelease" (fun _ ->
     Directory.ensure "bin/release_netcore"
     Shell.cleanDirs [ "bin/release_netcore" ]
@@ -76,15 +80,15 @@ Target.create "LocalRelease" (fun _ ->
            OutputPath = Some (__SOURCE_DIRECTORY__ </> "bin/release_netcore")
            Framework = Some "net5.0"
            Configuration = DotNet.BuildConfiguration.fromString configuration
-           MSBuildParams = { MSBuild.CliArguments.Create () with Properties =  [ "Version", release.AssemblyVersion ] } }) "src/FsAutoComplete"
+           MSBuildParams = { MSBuild.CliArguments.Create () with Properties =  [ versionProp ] } }) "src/FsAutoComplete"
 
     Directory.ensure "bin/release_as_tool"
     Shell.cleanDirs [ "bin/release_as_tool" ]
     DotNet.pack (fun p ->
        { p with
            OutputPath = Some (__SOURCE_DIRECTORY__ </> "bin/release_as_tool")
            Configuration = DotNet.BuildConfiguration.fromString configuration
-           MSBuildParams = { MSBuild.CliArguments.Create () with Properties =  [ "Version", release.AssemblyVersion; "PackAsTool", "true" ] } }) "src/FsAutoComplete"
+           MSBuildParams = { MSBuild.CliArguments.Create () with Properties =  [ versionProp; packAsToolProp; latestReleaseNotesProp ] } }) "src/FsAutoComplete"
 )
 
 Target.create "Clean" (fun _ ->

diff --git a/global.json b/global.json
@@ -1,5 +1,5 @@
 {
     "sdk": {
-        "version": "5.0.200"
+        "version": "5.0.300"
     }
 }
diff --git a/paket.dependencies b/paket.dependencies
@@ -70,3 +70,4 @@ group Build
   nuget Fake.DotNet.MsBuild
   nuget Fake.Api.GitHub
   nuget Microsoft.Build
+  nuget MSBuild.StructuredLogger
diff --git a/paket.lock b/paket.lock
@@ -856,7 +856,7 @@ NUGET
       System.Security.AccessControl (>= 5.0)
       System.Security.Principal.Windows (>= 5.0)
     Mono.Posix.NETStandard (1.0)
-    MSBuild.StructuredLogger (2.1.272)
+    MSBuild.StructuredLogger (2.1.507)
       Microsoft.Build (>= 16.4)
       Microsoft.Build.Framework (>= 16.4)
       Microsoft.Build.Tasks.Core (>= 16.4)

diff --git a/src/FsAutoComplete.BackgroundServices/FsAutoComplete.BackgroundServices.fsproj b/src/FsAutoComplete.BackgroundServices/FsAutoComplete.BackgroundServices.fsproj
@@ -5,6 +5,7 @@
     <AssemblyName>fsautocomplete.backgroundservices</AssemblyName>
     <ServerGarbageCollection>true</ServerGarbageCollection>
     <ConcurrentGarbageCollection>true</ConcurrentGarbageCollection>
+    <IsPackable>false</IsPackable>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\LanguageServerProtocol\LanguageServerProtocol.fsproj">

diff --git a/src/FsAutoComplete.Core/FsAutoComplete.Core.fsproj b/src/FsAutoComplete.Core/FsAutoComplete.Core.fsproj
@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net5.0</TargetFramework>
+    <IsPackable>false</IsPackable>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\LanguageServerProtocol\LanguageServerProtocol.fsproj" />

diff --git a/src/FsAutoComplete.Logging/FsAutoComplete.Logging.fsproj b/src/FsAutoComplete.Logging/FsAutoComplete.Logging.fsproj
@@ -2,6 +2,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
+    <IsPackable>false</IsPackable>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="..\..\paket-files\TheAngryByrd\FsLibLog\src\FsLibLog\FsLibLog.fs">

diff --git a/src/FsAutoComplete/FsAutoComplete.fsproj b/src/FsAutoComplete/FsAutoComplete.fsproj
@@ -6,8 +6,17 @@
     <AssemblyName>fsautocomplete</AssemblyName>
     <ServerGarbageCollection>true</ServerGarbageCollection>
     <ConcurrentGarbageCollection>true</ConcurrentGarbageCollection>
+    <!-- Paket currently lacks readme file support, tracked at https://github.com/fsprojects/Paket/issues/4031 -->
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <Description>A community-developed Language Server Protocol implementation for F#</Description>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <PackageIcon>logo.png</PackageIcon>
+    <PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
+    <Authors>FsAutoComplete contributors</Authors>
   </PropertyGroup>
   <ItemGroup>
+    <None Include="../../README.md" Pack="true" PackagePath="\"/>
+    <None Include="logo.png" Pack="true" PackagePath="\"/>
     <Compile Include="Options.fs" />
     <Compile Include="CommandResponse.fs" />
     <Compile Include="JsonSerializer.fs" />
@@ -26,9 +35,11 @@
     <ProjectReference Include="..\FsAutoComplete.BackgroundServices\FsAutoComplete.BackgroundServices.fsproj" />
     <ProjectReference Include="..\LanguageServerProtocol\LanguageServerProtocol.fsproj" />
   </ItemGroup>
+
   <PropertyGroup Condition=" '$(PackAsTool)' == 'true' ">
     <AssemblyName>dotnet-fsautocomplete</AssemblyName>
     <PackageId>fsautocomplete</PackageId>
+    <PackageType>DotnetTool</PackageType>
 
     <!-- workaround for not being able to have p2p dependencies in tool output dir https://github.com/nuget/home/issues/3891#issuecomment-377319939 -->
     <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>

diff --git a/src/FsAutoComplete/logo.png b/src/FsAutoComplete/logo.png
diff --git a/src/LanguageServerProtocol/LanguageServerProtocol.fsproj b/src/LanguageServerProtocol/LanguageServerProtocol.fsproj
@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
+    <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>