{"id":17033015,"url":"https://github.com/gbbr/breakcheck","last_synced_at":"2025-03-22T17:31:17.409Z","repository":{"id":57657597,"uuid":"181161713","full_name":"gbbr/breakcheck","owner":"gbbr","description":"Backwards compatibility linter for Go.","archived":false,"fork":false,"pushed_at":"2019-04-15T09:51:41.000Z","size":45,"stargazers_count":68,"open_issues_count":2,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-01T17:47:45.545Z","etag":null,"topics":["ci","go","golang","lint","linter","semver"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gbbr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-13T11:36:24.000Z","updated_at":"2024-01-19T23:44:22.000Z","dependencies_parsed_at":"2022-08-26T05:21:31.008Z","dependency_job_id":null,"html_url":"https://github.com/gbbr/breakcheck","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbbr%2Fbreakcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbbr%2Fbreakcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbbr%2Fbreakcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbbr%2Fbreakcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gbbr","download_url":"https://codeload.github.com/gbbr/breakcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244236094,"owners_count":20420752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","go","golang","lint","linter","semver"],"created_at":"2024-10-14T08:31:39.842Z","updated_at":"2025-03-22T17:31:17.100Z","avatar_url":"https://github.com/gbbr.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# breakcheck\n\nbreakcheck checks exported values, types and function declarations in your working tree for potential breaking changes against a given git reference. \n\n## Usage\n\n```\n$ breakcheck --help\nExample usage:\n  breakcheck               # compares working tree against git head\n  breakcheck --base=v1.0.0 # compares against tag v1.0.0\n\nFlags:\n  -base string\n    \tgit reference to compare against (default \"head\")\n  -private\n    \tinclude exported methods with private receivers\n  -v\tenable verbose mode\n```\n\n## Example\n\nBelow is an example output from running breakcheck against the datadog-agent repository:\n\n```\n$ breakcheck --base=HEAD~40\n\npkg/logs/config:\n  \n• Removed:\n    \u003c integration_config.go:17@HEAD~40:\n        const ContainerdType \n\npkg/util/clusteragent:\n  \n• Struct field \"ClusterAgentAPIEndpoint\" removed in struct \"DCAClient\":\n    \u003c clusteragent.go:42@HEAD~40:\n        struct DCAClient\n    \u003e clusteragent.go:57:\n        struct DCAClient\n  \n• Struct field \"ClusterAgentVersion\" type changed from \"string\" to \"version.Version\":\n    \u003c clusteragent.go:42@HEAD~40:\n        struct DCAClient\n  \n• Function return value (0) type changed from \"*DCAClient\" to \"DCAClientInterface\":\n    \u003c clusteragent.go:60@HEAD~40:\n        func GetClusterAgentClient() (*DCAClient, error)\n    \u003e clusteragent.go:75:\n        func GetClusterAgentClient() (DCAClientInterface, error)\n```\n\n## Caveats\n\n* 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.\n* Detecting changes in exported package level value declarations is limited to their name and type (when known). \n\n\n## Contributing\n\nContributions and feedback are very welcome, but please open an issue to discuss ideas before submitting to any work.\n\n## Similar work\n\n* https://golang.org/x/tools/internal/apidiff\n* https://github.com/bradleyfalzon/apicompat\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbbr%2Fbreakcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgbbr%2Fbreakcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbbr%2Fbreakcheck/lists"}