Skip to content

A tool to perform diff operations on the public members of an assembly.

License

Notifications You must be signed in to change notification settings

phirSOFT/ApiDiff

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ApiDiff

The goal of this project is to provide a language agnostic tool to detect changes in the public api and determine wheter this changes are breaking or not. The tool shoul be used to determine the correct semantic version of an api.

Assembly diff

An assembly can contain four kind of types, which define the publi API of that assembly.

  • classes
  • structs
  • interfaces
  • enums.

On theese entities the following operations can be performed.

  1. Addition

A new type is added to the assembly. This operation ist not breaking.

  1. Move

A type is renamed or moved to a different namespace. This operation is breaking.

  1. Deletion

A type is removed from the assembly. This operation is breaking.

  1. Inner change

The members of a type changed. This operation can be breaking.