Skip to content
Permalink
Browse files

πŸš€

  • Loading branch information...
gbbr committed Apr 14, 2019
1 parent cfebf16 commit 82baee2b6c2f53955822bfbec2c1cca71ef11cdd
Showing with 6 additions and 8 deletions.
  1. +6 βˆ’1 README.md
  2. +0 βˆ’2 go.mod
  3. +0 βˆ’5 go.sum
@@ -1,6 +1,6 @@
# breakcheck

breackcheck checks exported values, types and function declarations in your working tree for potential breaking changes against a given git reference.
breakcheck checks exported values, types and function declarations in your working tree for potential breaking changes against a given git reference.

## Usage

@@ -39,3 +39,8 @@ pkg/logs/config:

* If a function's argument is changed to an alias of the same type, breakcheck will fail to detect this and will report it as a change. Technically this is not a breaking change.
* Detecting changes in exported package level value declarations is limited to their name and type (when known).

## Similar projects

* https://github.com/golang/exp/tree/master/apidiff

This comment has been minimized.

Copy link
@dmitshur

dmitshur Apr 14, 2019

apidiff has semi-graduated from x/exp to x/tools:

golang.org/x/tools/internal/apidiff

This comment has been minimized.

Copy link
@gbbr

gbbr Apr 15, 2019

Author Owner

Updated. Feels a but weird linking to an internal package though

* https://github.com/bradleyfalzon/apicompat
2 go.mod
@@ -1,5 +1,3 @@
module github.com/gbbr/breakcheck

go 1.12

require github.com/kr/pretty v0.1.0
5 go.sum
@@ -1,5 +0,0 @@
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=

0 comments on commit 82baee2

Please sign in to comment.
You can’t perform that action at this time.