Merge pull request #10 from sensslen/simon/improve-publishing

Improve publishing
sensslen · Dec 15, 2023 · 62f4a0f · 62f4a0f
2 parents 33e7940 + 60b76a5
commit 62f4a0f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -58,7 +58,9 @@ jobs:
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
-          prerelease: true
+          prerelease: ${{ steps.version.outputs.prerelease != '' }}
+          generate_release_notes: true
+          fail_on_unmatched_files: true
           files: |
             release.zip
 

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Nuget License Utility [![release](https://github.com/sensslen/nuget-license/actions/workflows/release.yml/badge.svg)](https://github.com/sensslen/nuget-license/actions/workflows/release.yml) [![Tests](https://github.com/sensslen/nuget-license/actions/workflows/action.yml/badge.svg)](https://github.com/sensslen/nuget-license/actions/workflows/action.yml)
+# Nuget License Utility [![release](https://github.com/sensslen/nuget-license/actions/workflows/release.yml/badge.svg)](https://github.com/sensslen/nuget-license/actions/workflows/release.yml) [![Tests](https://github.com/sensslen/nuget-license/actions/workflows/action.yml/badge.svg)](https://github.com/sensslen/nuget-license/actions/workflows/action.yml) [![NuGet](https://img.shields.io/nuget/v/nuget-license.svg)](https://www.nuget.org/packages/nuget-license)
 
 A .net core tool to print and validate the licenses of a project. This tool supports .NET (Core), .NET Standard and .NET Framework Projects.
 
@@ -30,7 +30,7 @@ Usage: nuget-license [options]
 | `-t, --include-transitive`                     | When set, the analysis includes transitive packages (dependencies of packages that are directly installed to the project)                                                                                                                                                                                                                                                                                                                                  |
 | `-a, --allowed-license-types`                  | File containing all allowed licenses in JSON format. If omitted, all licenses are considered to be allowed.                                                                                                                                                                                                                                                                                                                                                |
 | `-ignore, --ignored-packages`                  | File containing a JSON formatted array containing package names, that should be ignored when validating licenses. Package names specified can contain simple Wildcard characters (*) which are used to match any number of characters. Note that even though a package is ignored, it's transitive dependencies are still validated. This Option is useful e.g. to exclude homegrown nuget packages from validation.                                       |
-| `-include-ignored, --include-ignored-packages` | This flag allows to explicitly include ignored packages in the output. licenses.                                                                                                                                                                                                                                                                                                                                                                           |
+| `-include-ignored, --include-ignored-packages` | This flag allows to explicitly include ignored packages in the output.                                                                                                                                                                                                                                                                                                                                                                           |
 | `-mapping, --licenseurl-to-license-mappings`   | When used, this option allows to override the url to license mapping built into the application (see [here](src/NuGetUtility/LicenseValidator/UrlToLicenseMapping.cs))                                                                                                                                                                                                                                                                                     |
 | `-override, --override-package-information`    | When used, this option allows to override the package information used for the validation. This makes sure that no attempt is made to get the associated information about the package from the available web resources. This is useful for packages that e.g. provide a license file as part of the nuget package which (at the time of writing) cannot be used for validation and thus requires the package's information to be provided by this option. |
 | `-d, --license-information-download-location`  | When used, this option downloads the html content of the license URL to the specified folder. This is done for all NuGet packages that specify a license URL instead of providing the license expression.                                                                                                                                                                                                                                                  |

diff --git a/src/NuGetUtility/NuGetUtility.csproj b/src/NuGetUtility/NuGetUtility.csproj
@@ -20,7 +20,8 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <Configurations>Debug;Release;TestWindows</Configurations>
-    <Platforms>AnyCPU</Platforms>
+    <Platforms>AnyCPU</Platforms>        
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>