dotnet-tool: add GCM icon to tool nuget package

Add the GCM icon to the NuGet package used for the dotnet tool.
The image is copied to the root of the package under a new `images`
directory (/images). The tool payload continues to be copied under the
required `/tool/net6.0/any` directory.

Modify the pack-tool.sh script to keep all build output under the /out
directory of the repository (which is in .gitignore). Output from
running pack-tool.sh now looks like this:

.
└── out
    └── shared
        └── DotnetTool
            └── nupkg
                └── Debug
                    ├── git-credential-manager.$VERSION.nupkg
                    ├── images       # icon
                    ├── payload      # dotnet publish output
                    └── payload.sym  # pdbs

The contents of the NuGet package looks like this:

.
├── [Content_Types].xml
├── _rels
├── git-credential-manager.nuspec
├── images
│   └── icon.png          # copied from the output images/ dir
├── package
│   └── services
│       └── metadata/...
└── tools
    └── net6.0
        └── any/...       # copied from the output payload/ dir

Author: mjcheetham

.github/workflows/release.yml

@@ -626,5 +626,5 @@ jobs:
 
     - name: Publish tool
       run: |
-        dotnet nuget push ./out/nupkg/*.nupkg \
+        dotnet nuget push ./out/shared/DotnetTool/nupkg/Release/*.nupkg \
           --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json

src/shared/DotnetTool/DotnetTool.csproj

@@ -9,6 +9,7 @@
       publishDir=$(PublishDir);
     </NuspecProperties>
     <NoBuild>true</NoBuild>
-    <OutputPath>../../../out/nupkg</OutputPath>
+    <OutputPath>$(ProjectOutPath)nupkg\$(Configuration)\</OutputPath>
+    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
   </PropertyGroup>
 </Project>

src/shared/DotnetTool/dotnet-tool.nuspec

@@ -5,11 +5,14 @@
         <version>$version$</version>
         <description>Secure, cross-platform Git credential storage with authentication to Azure Repos, GitHub, and other popular Git hosting services.</description>
         <authors>git-credential-manager</authors>
+        <icon>images\icon.png</icon>
+        <iconUrl>https://raw.githubusercontent.com/GitCredentialManager/git-credential-manager/main/assets/gcm-transparent.png</iconUrl>
         <packageTypes>
             <packageType name="DotnetTool" />
         </packageTypes>
   </metadata>
   <files>
-    <file src="$publishdir$" target="tools/net6.0/any" />
+    <file src="$publishdir$payload/" target="tools/net6.0/any" />
+    <file src="$publishdir$images/icon.png" target="images" />
   </files>
 </package>

src/shared/DotnetTool/icon.png

@@ -18,7 +18,6 @@ make_absolute () {
 #####################################################################
 # Lay out
 #####################################################################
-echo "Laying out files for dotnet tool..."
 # Parse script arguments
 for i in "$@"
 do
@@ -53,36 +52,25 @@ GITLAB_UI_SRC="$SRC/shared/GitLab.UI.Avalonia"
 DOTNET_TOOL="shared/DotnetTool"
 PROJ_OUT="$OUT/$DOTNET_TOOL"
 
-PACKAGE="$ROOT/nuget"
 CONFIGURATION="${CONFIGURATION:=Debug}"
 
 # Build parameters
 FRAMEWORK=net6.0
 
 # Outputs
-PAYLOAD="$PROJ_OUT/payload/$CONFIGURATION"
-SYMBOLOUT="$PROJ_OUT/payload.sym/$CONFIGURATION"
-
-# Cleanup payload directory
-if [ -d "$PAYLOAD" ]; then
-    echo "Cleaning existing payload directory '$PAYLOAD'..."
-    rm -rf "$PAYLOAD"
-fi
-
-# Cleanup symbol directory
-if [ -d "$SYMBOLOUT" ]; then
-    echo "Cleaning existing symbols directory '$SYMBOLOUT'..."
-    rm -rf "$SYMBOLOUT"
-fi
-
-# Cleanup package directory
-if [ -d "$PACKAGE" ]; then
-    echo "Cleaning existing package directory '$PACKAGE'..."
-    rm -rf "$PACKAGE"
+OUTDIR="$PROJ_OUT/nupkg/$CONFIGURATION"
+IMGOUT="$OUTDIR/images"
+PAYLOAD="$OUTDIR/payload"
+SYMBOLOUT="$OUTDIR/payload.sym"
+
+# Cleanup output directory
+if [ -d "$OUTDIR" ]; then
+    echo "Cleaning existing output directory '$OUTDIR'..."
+    rm -rf "$OUTDIR"
 fi
 
-# Ensure directories exist
-mkdir -p "$PAYLOAD" "$SYMBOLOUT" "$PACKAGE"
+# Ensure output directories exist
+mkdir -p "$PAYLOAD" "$SYMBOLOUT" "$IMGOUT"
 
 if [ -z "$DOTNET_ROOT" ]; then
     DOTNET_ROOT="$(dirname $(which dotnet))"
@@ -91,49 +79,54 @@ fi
 # Publish core application executables
 echo "Publishing core application..."
 $DOTNET_ROOT/dotnet publish "$GCM_SRC" \
-	--configuration="$CONFIGURATION" \
-	--framework="$FRAMEWORK" \
-	--output="$(make_absolute "$PAYLOAD")" \
+    --configuration="$CONFIGURATION" \
+    --framework="$FRAMEWORK" \
+    --output="$(make_absolute "$PAYLOAD")" \
     -p:UseAppHost=false || exit 1
 
 echo "Publishing Bitbucket UI helper..."
 $DOTNET_ROOT/dotnet publish "$BITBUCKET_UI_SRC" \
-	--configuration="$CONFIGURATION" \
-	--framework="$FRAMEWORK" \
-	--output="$(make_absolute "$PAYLOAD")" \
+    --configuration="$CONFIGURATION" \
+    --framework="$FRAMEWORK" \
+    --output="$(make_absolute "$PAYLOAD")" \
     -p:UseAppHost=false || exit 1
 
 echo "Publishing GitHub UI helper..."
 $DOTNET_ROOT/dotnet publish "$GITHUB_UI_SRC" \
-	--configuration="$CONFIGURATION" \
-	--framework="$FRAMEWORK" \
-	--output="$(make_absolute "$PAYLOAD")" \
+    --configuration="$CONFIGURATION" \
+    --framework="$FRAMEWORK" \
+    --output="$(make_absolute "$PAYLOAD")" \
     -p:UseAppHost=false || exit 1
 
 echo "Publishing GitLab UI helper..."
 $DOTNET_ROOT/dotnet publish "$GITLAB_UI_SRC" \
-	--configuration="$CONFIGURATION" \
-	--framework="$FRAMEWORK" \
-	--output="$(make_absolute "$PAYLOAD")" \
+    --configuration="$CONFIGURATION" \
+    --framework="$FRAMEWORK" \
+    --output="$(make_absolute "$PAYLOAD")" \
     -p:UseAppHost=false || exit 1
 
 # Collect symbols
 echo "Collecting managed symbols..."
 mv "$PAYLOAD"/*.pdb "$SYMBOLOUT" || exit 1
 
+# Copy DotnetToolSettings.xml file
+echo "Copying out package configuration files..."
+cp "$SRC/$DOTNET_TOOL/DotnetToolSettings.xml" "$PAYLOAD/"
+
+# Copy package icon image
+echo "Copying images..."
+cp "$SRC/$DOTNET_TOOL/icon.png" "$IMGOUT" || exit 1
+
 echo "Build complete."
 
 #####################################################################
 # Pack dotnet tool
 #####################################################################
 echo "Creating dotnet tool package..."
 
-mkdir -p "$PACKAGE" || exit 1
-echo "Laying out files..."
-cp -r "$SRC/$DOTNET_TOOL/DotnetToolSettings.xml" \
-    "$PAYLOAD/." \
-    "$PACKAGE/"
-
-dotnet pack "$SRC/$DOTNET_TOOL/DotnetTool.csproj" /p:PackageVersion="$VERSION" /p:PublishDir="$PACKAGE/"
+dotnet pack "$SRC/$DOTNET_TOOL/DotnetTool.csproj" \
+    /p:Configuration="$CONFIGURATION" \
+    /p:PackageVersion="$VERSION" \
+    /p:PublishDir="$OUTDIR/"
 
 echo "Dotnet tool pack complete."