README.md

.NET API Portability

This repository contains the source code for .NET Portability Analyzer tools and dependencies.

For a quick introduction, check out this video on Channel 9:

Using this Repository

Windows

1. Install Visual Studio 2017 with .NET Core Workload
2. Building:
   • Visual Studio: PortabilityTools.sln
   • Powershell: .\build.ps1 -Configuration Debug -Platform AnyCPU

Linux/Mac

1. Install .NET Core SDK
2. Execute: build.sh
3. Go to: bin/Debug/ApiPort/netcoreapp1.0
4. Run ApiPort by executing: dotnet ApiPort.dll

• Example: dotnet ApiPort.dll listTargets
• Example: dotnet ApiPort.dll analyze -f Foo.dll -r HTML

Documentation

• Introduction
• Platform Portability
• Breaking Changes
• .NET Portability Analyzer (Console application)
  • .NET Core application
• .NET Portability Analyzer (Visual Studio extension)

Projects

Project	Description
ApiPort	Console tool to access portability webservice
ApiPort.Core	Cross-platform .NET Core application
ApiPort.Vsix	Visual Studio Extension
Microsoft.Fx.Portability	Provides common types for API Port
Microsoft.Fx.Portability.MetadataReader	Implements a dependency finder based off of System.Reflection.Metadata. The library will generate DocIds that conform to these specifications.
Microsoft.Fx.Portability.Offline	Provides access to data in an offline setting so network calls are not needed
Microsoft.Fx.Portability.Reporting.Html	Provides an HTML report for ApiPort (used in offline mode)
Microsoft.Fx.Portability.Reporting.Json	Provides a JSON reporter for ApiPort (used in offline mode)

Builds

The libraries are continuously published to dotnet-apiport MyGet gallery. The Visual Studio extension is published to Open VSIX Gallery. The latest version number of each library can be seen in that gallery.

How to Engage, Contribute and Provide Feedback

Here are some ways to contribute:

• Update/Add recommended changes
• Try things out!
• File issues
• Join in design conversations

Want to get more familiar with what's going on in the code?

• Pull requests: Open/Closed

Looking for something to work on? The list of up-for-grabs issues is a great place to start.

We're re-using the same contributing approach as .NET Core. You can check out the .NET Core contributing guide at the corefx repo wiki for more details.

• How to Contribute
  • Contributing Guide
  • Developer Guide

You are also encouraged to start a discussion on the .NET Foundation forums!

Related Projects

For an overview of all the .NET related projects, have a look at the .NET home repository.

License

This project is licensed under the MIT license.