Skip to content

Commit

Permalink
Merge pull request #71 from JakeGinnivan/delete-apiapprover
Browse files Browse the repository at this point in the history
Remove ApiApprover
  • Loading branch information
danielmarbach committed Aug 12, 2019
2 parents 4accca3 + 72dddff commit 230291b
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 105 deletions.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,6 @@

# ApiApprover

_This package is obsoleted with a compiler warning_

Api Approver is a simple NuGet package built on top of [ApprovalTests.Net](https://github.com/approvals/ApprovalTests.Net) which approves the public API of an assembly.

Whenever the public API changes the Api Approver test will fail. Running the test manually will pop up a diff tool allowing you to see the changes. If the changes are fine (i.e an added overload) then the changes can simply be approved and test will pass again.

![ApiApprover](http://jake.ginnivan.net/assets/posts/2012-02-19-apiapprover/ApiChange.png)

There are times though that changes to the public API is accidental. Api Approver simply adds a step that all public API changes have to be reviewed by a developer and accepted, saving accidental breaking changes being shipped.

## PublicApiGenerator

PublicApiGenerator has no dependencies and simply creates a string the represents the public API. Any approval library can be used to approve the generated public API.
Expand Down
10 changes: 2 additions & 8 deletions src/ApiApprover.sln
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.27004.2009
# Visual Studio Version 16
VisualStudioVersion = 16.0.29020.237
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ApiApprover", "ApiApprover\ApiApprover.csproj", "{75D25110-B0C7-4BCD-9B28-0679DD036C43}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PublicApiGeneratorTests", "PublicApiGeneratorTests\PublicApiGeneratorTests.csproj", "{3D33D60B-860D-4706-ABA3-11F485FB0C6F}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PublicApiGenerator", "PublicApiGenerator\PublicApiGenerator.csproj", "{18D13F6D-7AFF-4E23-9905-6AF5F55F8852}"
Expand All @@ -27,10 +25,6 @@ Global
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{75D25110-B0C7-4BCD-9B28-0679DD036C43}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{75D25110-B0C7-4BCD-9B28-0679DD036C43}.Debug|Any CPU.Build.0 = Debug|Any CPU
{75D25110-B0C7-4BCD-9B28-0679DD036C43}.Release|Any CPU.ActiveCfg = Release|Any CPU
{75D25110-B0C7-4BCD-9B28-0679DD036C43}.Release|Any CPU.Build.0 = Release|Any CPU
{3D33D60B-860D-4706-ABA3-11F485FB0C6F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{3D33D60B-860D-4706-ABA3-11F485FB0C6F}.Debug|Any CPU.Build.0 = Debug|Any CPU
{3D33D60B-860D-4706-ABA3-11F485FB0C6F}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down
24 changes: 0 additions & 24 deletions src/ApiApprover/ApiApprover.csproj

This file was deleted.

29 changes: 0 additions & 29 deletions src/ApiApprover/ApiApprover.v2.ncrunchproject

This file was deleted.

33 changes: 0 additions & 33 deletions src/ApiApprover/PublicApiApprover.cs

This file was deleted.

2 changes: 1 addition & 1 deletion src/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</PropertyGroup>

<PropertyGroup>
<MinVerMinimumMajorMinor>9.0</MinVerMinimumMajorMinor>
<MinVerMinimumMajorMinor>10.0</MinVerMinimumMajorMinor>
<NoWarn>NU5105</NoWarn>
</PropertyGroup>

Expand Down

0 comments on commit 230291b

Please sign in to comment.