Merge branch 'master' into v2.3.0-readme

Author: WalkerCodeRanger

PublishingRelease.md

@@ -0,0 +1,29 @@
+# Publishing a Release
+
+## Preparing for the Release
+
+* Make all changes for the release on `master` (except for the readme).
+* Have a `vX.Y.Z-readme` branch ready with the readme for the next version.
+* Prepare a branch in the docs repo with updated docs for the new version and verify the doc
+  comments for the new version.
+
+## Steps to Publish Release
+
+1. Create an *annotated* tag of the version number being published prefixed with "v". The tag description should match the tag name.
+2. Wait for the build of that tag to complete in Appveyor.
+3. Download the nupkg and snupkg files from the assets tab of Appveyor.
+4. Upload those to NuGet with the new readme from the readme branch.
+   * Remove the build and NuGet status from the top of the readme before putting it in NuGet.
+
+## After Publishing a Release
+
+These steps only need to be done for a non-prerelease version.
+
+1. Create a release from the tag on github.
+   * Write up the changes in that version.
+   * Attach the nupkg and snupkg files to the release in github.
+2. Merge the `vX.Y.Z-readme` branch into `master`.
+3. Create a new `vX.Y.Z-readme` branch for the next version.
+4. Mark the milestone, and any included issues, done with the current date.
+5. Update the `PublicAPI` files to reflect the newly published APIs
+6. Update the benchmark to reference the new version as the previous version.

Semver.Benchmarks/Semver.Benchmarks.csproj

@@ -20,18 +20,25 @@
         <Compile Include="..\Semver\*.cs">
             <Link>LocalVersion\%(RecursiveDir)%(FileName)%(Extension)</Link>
         </Compile>
-        <Compile Include="..\Semver\Utility\*.cs">
+        <Compile Include="..\Semver\Utility\**\*.cs">
             <Link>LocalVersion\%(RecursiveDir)\Utility\%(FileName)%(Extension)</Link>
         </Compile>
-        <Compile Include="..\Semver\Comparers\*.cs">
+        <Compile Include="..\Semver\Comparers\**\*.cs">
             <Link>LocalVersion\%(RecursiveDir)\Comparers\%(FileName)%(Extension)</Link>
         </Compile>
+        <Compile Include="..\Semver\Parsing\**\*.cs">
+            <Link>LocalVersion\Ranges\%(RecursiveDir)%(FileName)%(Extension)</Link>
+        </Compile>
         <Compile Include="..\Semver\Ranges\**\*.cs">
             <Link>LocalVersion\Ranges\%(RecursiveDir)%(FileName)%(Extension)</Link>
         </Compile>
     </ItemGroup>
 
     <ItemGroup>
+      <Compile Remove="..\Semver\LeftBoundedRange.cs" />
       <Compile Remove="..\Semver\Ranges\Npm\NpmComparator.cs" />
+      <Compile Remove="..\Semver\RightBoundedRange.cs" />
+      <Compile Remove="..\Semver\SemVersionParser.cs" />
+      <Compile Remove="..\Semver\SemVersionParsingOptions.cs" />
     </ItemGroup>
 </Project>

Semver.Test/Builders/NpmRangeParsingTestCaseBuilder.cs

@@ -1,5 +1,4 @@
 using System;
-using Semver.Ranges;
 using Semver.Test.Helpers;
 using Semver.Test.TestCases;
 

Semver.Test/Builders/UnbrokenSemVersionRangeBuilder.cs

@@ -1,6 +1,4 @@
-using Semver.Ranges;
-
-namespace Semver.Test.Builders
+namespace Semver.Test.Builders
 {
     public static class UnbrokenSemVersionRangeBuilder
     {

Semver.Test/Comparers/UnbrokenSemVersionRangeComparerTests.cs

@@ -1,5 +1,4 @@
 using Semver.Comparers;
-using Semver.Ranges;
 using Xunit;
 
 namespace Semver.Test.Comparers

Semver.Test/Ranges/Parsers/GeneralRangeParserTests.cs renamed to Semver.Test/Parsing/GeneralRangeParserTests.cs

@@ -1,9 +1,8 @@
-using Semver.Ranges;
-using Semver.Ranges.Parsers;
+using Semver.Parsing;
 using Xunit;
-using static Semver.Ranges.SemVersionRangeOptions;
+using static Semver.SemVersionRangeOptions;
 
-namespace Semver.Test.Ranges.Parsers
+namespace Semver.Test.Parsing
 {
     public class GeneralRangeParserTests
     {

Semver.Test/ReadmeTests.cs

@@ -1,5 +1,4 @@
-using Semver.Ranges;
-using Xunit;
+using Xunit;
 using Xunit.Abstractions;
 
 namespace Semver.Test
@@ -49,14 +48,14 @@ public void ReadmeRuns()
             var prereleaseRange = SemVersionRange.ParseNpm("^1.0.0", includeAllPrerelease: true);
             console.WriteLine($"Range: {range}");
             console.WriteLine($"Prerelease range: {prereleaseRange}");
-            console.WriteLine($"Range includes version: {range.Contains(version)}");
+            console.WriteLine($"Range includes version {version}: {range.Contains(version)}");
             console.WriteLine($"Prerelease range includes version: {prereleaseRange.Contains(version)}");
 
             // Alternative: another way to call SemVersionRange.Contains(version)
             Assert.False(version.Satisfies(range));
 
             // Alternative: slower because it parses the range on every call
-            Assert.True(version.Satisfies("^1.0.0", SemVersionRangeOptions.IncludeAllPrerelease));
+            Assert.True(version.SatisfiesNpm("^1.0.0", includeAllPrerelease: true));
         }
     }
 }

Semver.Test/Ranges/SemVersionRangeNpmParsingTests.cs renamed to Semver.Test/SemVersionRangeNpmParsingTests.cs

@@ -1,12 +1,11 @@
 using System;
-using Semver.Ranges;
 using Semver.Test.Helpers;
 using Semver.Test.TestCases;
 using Xunit;
 using static Semver.Test.Builders.NpmRangeParsingTestCaseBuilder;
 using static Semver.Test.Builders.UnbrokenSemVersionRangeBuilder;
 
-namespace Semver.Test.Ranges
+namespace Semver.Test
 {
     public class SemVersionRangeNpmParsingTests
     {

Semver.Test/Ranges/SemVersionRangeStandardParsingTests.cs renamed to Semver.Test/SemVersionRangeStandardParsingTests.cs

@@ -1,12 +1,11 @@
 using System;
-using Semver.Ranges;
 using Semver.Test.Helpers;
 using Semver.Test.TestCases;
 using Xunit;
-using static Semver.Ranges.SemVersionRangeOptions;
+using static Semver.SemVersionRangeOptions;
 using static Semver.Test.Builders.UnbrokenSemVersionRangeBuilder;
 
-namespace Semver.Test.Ranges
+namespace Semver.Test
 {
     public class SemVersionRangeStandardParsingTests
     {

Semver.Test/Ranges/SemVersionRangeStandardParsingToStringTests.cs renamed to Semver.Test/SemVersionRangeStandardParsingToStringTests.cs

@@ -1,9 +1,8 @@
-using Semver.Ranges;
-using Semver.Test.TestCases;
+using Semver.Test.TestCases;
 using Xunit;
-using static Semver.Ranges.SemVersionRangeOptions;
+using static Semver.SemVersionRangeOptions;
 
-namespace Semver.Test.Ranges
+namespace Semver.Test
 {
     /// <summary>
     /// It was difficult to ensure that the <see cref="SemVersionRange.ToString"/> would output