Updated NuGet packaging metadata #1093 (#1103)

microsoft · Jun 8, 2022 · 6bd50e0 · 6bd50e0
1 parent 891eefd
commit 6bd50e0
Show file tree

Hide file tree

Showing 20 changed files with 123 additions and 66 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -11,4 +11,4 @@
 - **Code changes**
   - [ ] Have unit tests created/ updated
   - [ ] Link to a filed issue
-  - [ ] [Change log](https://github.com/Microsoft/PSRule/blob/main/docs/CHANGELOG-v1.md) has been updated with change under unreleased section
+  - [ ] [Change log](https://github.com/Microsoft/PSRule/blob/main/docs/CHANGELOG-v2.md) has been updated with change under unreleased section
diff --git a/docs/CHANGELOG-v2.md b/docs/CHANGELOG-v2.md
@@ -22,6 +22,8 @@ What's changed since v2.1.0:
     [#1079](https://github.com/microsoft/PSRule/pull/1079)
   - Bump Microsoft.NET.Test.Sdk to 17.2.0.
     [#1089](https://github.com/microsoft/PSRule/pull/1089)
+  - Updated NuGet packaging metadata by @BernieWhite.
+    [#1093](https://github.com/microsoft/PSRule/issues/1093)
 - Bug fixes:
   - Fixed grouping of logical operators in object path by @BernieWhite.
     [#1101](https://github.com/microsoft/PSRule/issues/1101)

diff --git a/docs/assets/package_icon.png b/docs/assets/package_icon.png
diff --git a/src/PSRule.Badges/PSRule.Badges.csproj b/src/PSRule.Badges/PSRule.Badges.csproj
@@ -1,19 +1,32 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <AssemblyName>Microsoft.PSRule.Badges</AssemblyName>
+    <RootNamespace>PSRule.Badges</RootNamespace>
     <TargetFramework>netstandard2.0</TargetFramework>
     <LangVersion>8.0</LangVersion>
+    <OutputType>Library</OutputType>
+    <ProjectGuid>{309bed8b-4e60-4c42-a2b4-37a2e7ebef3f}</ProjectGuid>
+    <DebugType>portable</DebugType>
     <NeutralLanguage>en-US</NeutralLanguage>
     <Authors>Bernie White</Authors>
     <AssemblyTitle>PSRule.Badges</AssemblyTitle>
-    <RepositoryUrl>https://github.com/Microsoft/PSRule</RepositoryUrl>
-    <PackageLicenseExpression>https://github.com/Microsoft/PSRule/blob/main/LICENSE</PackageLicenseExpression>
+    <RepositoryUrl>https://github.com/microsoft/PSRule</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <PackageProjectUrl>https://aka.ms/ps-rule</PackageProjectUrl>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageId>Microsoft.PSRule.Badges</PackageId>
+    <PackageTags>PSRule;</PackageTags>
+    <EnableNuget>true</EnableNuget>
     <Version>0.0.1</Version>
     <Company>Microsoft Corporation</Company>
     <Copyright>Copyright (c) Microsoft Corporation. Licensed under the MIT License.</Copyright>
     <Description>Contains resources for PSRule to work with badges.
 
 This project uses GitHub Issues to track bugs and feature requests. See GitHub project for more information.</Description>
+    <PackageReleaseNotes>For a list of changes see https://aka.ms/ps-rule/changelog.</PackageReleaseNotes>
+    <PackageIcon>package_icon.png</PackageIcon>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(OS)' == 'Windows_NT'">
@@ -28,6 +41,17 @@ This project uses GitHub Issues to track bugs and feature requests. See GitHub p
     <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\..\docs\assets\package_icon.png">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+    <None Include="README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
   </ItemGroup>

diff --git a/src/PSRule.Badges/Properties/AssemblyInfo.cs b/src/PSRule.Badges/Properties/AssemblyInfo.cs
@@ -3,5 +3,5 @@
 
 using System.Runtime.CompilerServices;
 
-[assembly: InternalsVisibleTo("PSRule")]
+[assembly: InternalsVisibleTo("Microsoft.PSRule")]
 [assembly: InternalsVisibleTo("PSRule.Tests")]
diff --git a/src/PSRule.Badges/README.md b/src/PSRule.Badges/README.md
@@ -0,0 +1,6 @@
+# PSRule Badges library for .NET
+
+Microsoft.PSRule.Badges provides underlying support for creating badges within the PSRule badge API.
+For information about the PSRule badge API, see [PSRule Badge API][1].
+
+  [1]: https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Badges/
diff --git a/src/PSRule.Badges/SvgBuilder.cs b/src/PSRule.Badges/SvgBuilder.cs
@@ -1,11 +1,14 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 using System;
 using System.Text;
 
 namespace PSRule.Badges
 {
+    /// <summary>
+    /// Generate SVG badges.
+    /// </summary>
     internal sealed class SvgBuilder
     {
         private readonly int _Width;

diff --git a/src/PSRule.Benchmark/PSRule.Benchmark.csproj b/src/PSRule.Benchmark/PSRule.Benchmark.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
@@ -7,7 +7,7 @@
     <ProjectGuid>{3ec0912f-bfc7-4b53-a1a1-0ba993c6282e}</ProjectGuid>
     <Authors>Bernie White</Authors>
     <RepositoryUrl>https://github.com/Microsoft/PSRule</RepositoryUrl>
-    <PackageLicenseExpression>https://github.com/Microsoft/PSRule/blob/main/LICENSE</PackageLicenseExpression>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Company>Microsoft Corporation</Company>
     <Copyright>Copyright (c) Microsoft Corporation. Licensed under the MIT License.</Copyright>
   </PropertyGroup>

diff --git a/src/PSRule.BuildTool/PSRule.BuildTool.csproj b/src/PSRule.BuildTool/PSRule.BuildTool.csproj
@@ -7,7 +7,7 @@
     <Authors>Bernie White</Authors>
     <AssemblyTitle>PSRule.BuildTool</AssemblyTitle>
     <RepositoryUrl>https://github.com/Microsoft/PSRule</RepositoryUrl>
-    <PackageLicenseExpression>https://github.com/Microsoft/PSRule/blob/main/LICENSE</PackageLicenseExpression>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Version>0.0.1</Version>
     <Company>Microsoft Corporation</Company>
     <Copyright>Copyright (c) Microsoft Corporation. Licensed under the MIT License.</Copyright>

diff --git a/src/PSRule/Common/KeyMapDictionary.cs b/src/PSRule/Common/KeyMapDictionary.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 using System;
@@ -13,27 +13,27 @@ public abstract class KeyMapDictionary<TValue> : DynamicObject, IDictionary<stri
     {
         private readonly Dictionary<string, TValue> _Map;
 
-        protected KeyMapDictionary()
+        internal protected KeyMapDictionary()
         {
             _Map = new Dictionary<string, TValue>(StringComparer.OrdinalIgnoreCase);
         }
 
-        protected KeyMapDictionary(KeyMapDictionary<TValue> map)
+        internal protected KeyMapDictionary(KeyMapDictionary<TValue> map)
         {
             if (map == null)
                 throw new ArgumentNullException(nameof(map));
 
             _Map = new Dictionary<string, TValue>(map._Map, StringComparer.OrdinalIgnoreCase);
         }
 
-        protected KeyMapDictionary(IDictionary<string, TValue> dictionary)
+        internal protected KeyMapDictionary(IDictionary<string, TValue> dictionary)
         {
             _Map = dictionary == null ?
                 new Dictionary<string, TValue>(StringComparer.OrdinalIgnoreCase) :
                 new Dictionary<string, TValue>(dictionary, StringComparer.OrdinalIgnoreCase);
         }
 
-        protected KeyMapDictionary(Hashtable hashtable)
+        internal protected KeyMapDictionary(Hashtable hashtable)
             : this()
         {
             Load(hashtable);

diff --git a/src/PSRule/Common/StringBuilderExtensions.cs b/src/PSRule/Common/StringBuilderExtensions.cs
@@ -1,9 +1,9 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 using System.Text;
 
-namespace PSRule.Common
+namespace PSRule
 {
     internal static class StringBuilderExtensions
     {

diff --git a/src/PSRule/Definitions/Resource.cs b/src/PSRule/Definitions/Resource.cs
@@ -348,7 +348,7 @@ public sealed class ResourceExtent
     [DebuggerDisplay("Kind = {Kind}, Id = {Id}")]
     public abstract class Resource<TSpec> where TSpec : Spec, new()
     {
-        protected Resource(ResourceKind kind, string apiVersion, SourceFile source, ResourceMetadata metadata, IResourceHelpInfo info, ISourceExtent extent, TSpec spec)
+        internal protected Resource(ResourceKind kind, string apiVersion, SourceFile source, ResourceMetadata metadata, IResourceHelpInfo info, ISourceExtent extent, TSpec spec)
         {
             Kind = kind;
             ApiVersion = apiVersion;

diff --git a/src/PSRule/Help/MarkdownStream.cs b/src/PSRule/Help/MarkdownStream.cs
@@ -10,7 +10,7 @@ namespace PSRule.Help
     internal delegate bool CharacterMatchDelegate(char c);
 
     [DebuggerDisplay("StartPos = (L: {Start}, C: {Column}), EndPos = (L: {End}, C: {Column.End}), Text = {Text}")]
-    public sealed class SourceExtent
+    internal sealed class SourceExtent
     {
         private readonly string _Source;
 

diff --git a/src/PSRule/Help/MarkdownToken.cs b/src/PSRule/Help/MarkdownToken.cs
@@ -6,7 +6,7 @@
 
 namespace PSRule.Help
 {
-    public enum MarkdownTokenType
+    internal enum MarkdownTokenType
     {
         None = 0,
 
@@ -32,7 +32,7 @@ public enum MarkdownTokenType
     }
 
     [Flags()]
-    public enum MarkdownTokens
+    internal enum MarkdownTokens
     {
         None = 0,
 
@@ -52,7 +52,7 @@ public enum MarkdownTokens
         PreserveLineEnding = 40
     }
 
-    public static class MarkdownTokenFlagExtensions
+    internal static class MarkdownTokenFlagExtensions
     {
         public static bool IsEnding(this MarkdownTokens flags)
         {
@@ -71,7 +71,7 @@ public static bool ShouldPreserve(this MarkdownTokens flags)
     }
 
     [DebuggerDisplay("Type = {Type}, Text = {Text}")]
-    public sealed class MarkdownToken
+    internal sealed class MarkdownToken
     {
         public SourceExtent Extent { get; set; }