Merged from upstream

NStack/NStack.csproj

@@ -1,31 +1,44 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <Import Project="..\packages\NuGet.Build.Packaging.0.1.248\build\NuGet.Build.Packaging.props" Condition="Exists('..\packages\NuGet.Build.Packaging.0.1.248\build\NuGet.Build.Packaging.props')" />
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
-    <RepositoryUrl>https://github.com/tig/NStack</RepositoryUrl>
+    <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <PackageId>NStack.Core</PackageId>
     <GeneratePackageOnBuild Condition=" '$(Configuration)' == 'Release' ">true</GeneratePackageOnBuild>
     <Authors>Miguel de Icaza</Authors>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Owners>Miguel de Icaza</Owners>
-    <PackageProjectUrl>http://github.com/migueldeicaza/NStack</PackageProjectUrl>
     <Summary>NStack.Core brings a set of updated string APIs to .NET including a UTF8-string aware string.</Summary>
     <PackageTags>unicode, c#</PackageTags>
     <Title>NStack.Core</Title>
+
+    <PackageProjectUrl>https://github.com/gui-cs/NStack/</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/gui-cs/NStack.git</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <!-- Publish the repository URL in the built .nupkg (in the NuSpec <Repository> element) -->
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <!-- Embed source files that are not tracked by the source control manager in the PDB -->
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <PackageIcon>logo48.png</PackageIcon>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+
     <Description>NStack.Core brings a set of updated string APIs to .NET.  
 
 It starts with a new string type that is focused on Unicode code-points as opposed to the historical chars and  UTF-16 encoding and introduces a utf8 string that supports slicing</Description>
     <PackageReleaseNotes>
+Version 1.0.0 - Moderinized API doc generation and now using gitflow
+   * Fixes #59. Automatically generate API docs via github action 
+   * Fixes #61. ustring.IsNullOrEmpty doesn't work the same way as the string.IsNullOrEmpty method. 
+
+Previous Versions:
 0.17: Fork by @tig modernize build/deploy and help publishing newer versions. No functional changes.
 0.16: Fixes issue #51 (chess symbols);  
 0.15: Fixes to MaxRune;   ColumnWidth differentiates between non-printable and nul characters; Rune has a constructor from two surrogate pairs; contributions by @BDisp;  
 0.14: Upgrade the NetStandard dependencies;
 0.13: Fixes ustring.Map() and Lower(); Extends Rune.IsValid to match Go; add Rune.ExpectedSizeFromFirstByte()  plus a bug fix;
 stack 
-0.12: Rebuilt
-Rebuild with an older Roslyn, to prevent regressions on Xamarin.
-0.10:
-Merged some changes from upstream.
+0.12: Rebuild with an older Roslyn, to prevent regressions on Xamarin.
+0.10: Merged some changes from upstream.
 
 0.9:
 Added ustring.ColumnWidth to return number of columns that a ustring takes in a console.
@@ -37,12 +50,16 @@ Added ustring.ColumnWidth to return number of columns that a ustring takes in a
 * Introduced new method in Rune to measure the width in columns for console applications.
 </PackageReleaseNotes>
 
-    <!--Version is managed by gitver now. See publish.yml-->
-    <AssemblyVersion>0.20.0.0</AssemblyVersion>
-    <FileVersion>0.20.0.0</FileVersion>
-    <InformationalVersion>0.20.0+Branch.main.Sha.8157792de6c7c039bf62aea2965505b27d1fffc9</InformationalVersion>
-    <Version>0.20.0</Version>
+    <!-- Version numbers are automatically updated by gitversion when a release is released -->
+    <!-- In the source tree the version will always be 1.0 for all projects. -->
+    <!-- Do not modify these. Do NOT commit after manually running `dotnet-gitversion /updateprojectfiles` -->
+    <AssemblyVersion>1.0</AssemblyVersion>
+    <FileVersion>1.0</FileVersion>
+    <Version>1.0</Version>
+    <InformationalVersion>1.0</InformationalVersion>
   </PropertyGroup>
+
+
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
@@ -53,8 +70,26 @@ Added ustring.ColumnWidth to return number of columns that a ustring takes in a
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <LangVersion>Latest</LangVersion>
   </PropertyGroup>
-  <Import Project="..\packages\NuGet.Build.Packaging.0.1.248\build\NuGet.Build.Packaging.targets" Condition="Exists('..\packages\NuGet.Build.Packaging.0.1.248\build\NuGet.Build.Packaging.targets')" />
+
   <ItemGroup>
     <PackageReference Include="System.ValueTuple" Version="4.5.0" />
   </ItemGroup>
+
+  <!-- API Documentation -->
+  <ItemGroup>
+    <None Include="..\docfx\images\logo48.png">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+    <None Include="..\README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
+  <!-- Enable Nuget Source Link for github -->
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+  </ItemGroup>
+
 </Project>

README.md

@@ -32,3 +32,31 @@ can exist without them being valid UTF8 strings, but rather a collection of byte
 
 [1] For example, older file systems can have filenames that made sense with
 a particular character set and are effectively not possible to map into strings.
+
+
+# Version Numbers
+
+Version info for NStack is managed by [gitversion](https://gitversion.net).
+
+Install `gitversion`:
+
+```powershell
+dotnet tool install --global GitVersion.Tool
+dotnet-gitversion
+```
+
+The project version (the nuget package and in `NStack.dll`) is determined from the latest `git tag`. 
+
+The format of version numbers is `vmajor.minor.patch.build.height` and follows the [Semantic Versioning](https://semver.org/) rules.
+
+To define a new version (e.g. with a higher `major`, `minor`, `patch`, or `build` value) tag a commit using `git tag`:
+
+```powershell
+git tag v1.3.4-beta.5 -a -m "Release v1.3.4 Beta 5"
+dotnet-gitversion /updateprojectfiles
+dotnet build -c Release
+```
+
+**DO NOT COMMIT AFTER USING `/updateprojectfiles`!**
+
+Doing so will update the `.csproj` files in your branch with version info, which we do not want.

docfx/build.ps1

@@ -6,6 +6,9 @@ dotnet build --configuration Release ../NStack.sln
 rm ../docs -Recurse -Force -ErrorAction SilentlyContinue
 
 
+$env:DOCFX_SOURCE_BRANCH_NAME="main"
+
+
 $env:DOCFX_SOURCE_BRANCH_NAME="main"
 
 docfx --metadata