{"action":"created","comment":{"url":"https://api.github.com/repos/cafejojo/schaapi/pulls/comments/189623632","pull_request_review_id":121839102,"id":189623632,"diff_hunk":"@@ -4,3 +4,129 @@\n [![Codecov](https://img.shields.io/codecov/c/github/cafejojo/schaapi/master.svg?style=for-the-badge)](https://codecov.io/gh/cafejojo/schaapi/)\n [![Schaap](https://img.shields.io/badge/Contains-%F0%9F%90%91-FF69B4.svg?style=for-the-badge)](https://github.com/cafejojo/schaapi)\n [![Built with love](https://img.shields.io/badge/built%20with-%E2%9D%A4%EF%B8%8F-red.svg?style=for-the-badge)](https://github.com/cafejojo/)\n+\n+Schaapi ensures Safe Changes for APIs of libraries. It specifically focuses on semantic breaking changes, but provides a general purpose pipeline that is also applicable to detection of other types of breaking changes. The default implementation detects incompatibilities between Java libraries and Java projects using that library.\n+\n+## Requirements and Installation\n+Schaapi requires JRE 8 and has been tested on Windows and Unix systems.\n+\n+## Usage\n+Execute `./gradlew :application:run` with the following command line options:\n+\n+```\n+usage: schaapi -o <arg> -l <arg> -u <arg> [--maven_dir <arg>]\n+       [--repair_maven] [--pattern_detector_minimum_count <arg>]\n+       [--test_generator_enable_output] [--test_generator_timeout <arg>]\n+ -o,--output_dir <arg>                       The output directory.\n+ -l,--library_dir <arg>                      The library directory.\n+ -u,--user_dirs <arg>                        The user directories,\n+                                             separated by semi-colons.\n+    --maven_dir <arg>                        The directory to run Maven\n+                                             from.\n+    --repair_maven                           Repairs the Maven\n+                                             installation.\n+    --pattern_detector_minimum_count <arg>   The minimum number of\n+                                             occurrences for a statement\n+                                             to be considered frequent.\n+    --test_generator_enable_output           True if test generator output\n+                                             should be shown.\n+    --test_generator_timeout <arg>           The time limit for the test\n+                                             generator.\n+```\n+\n+## Pipeline Stages\n+### 1 Periodic Project Mining\n+| Stage                                         | Description |\n+| --------------------------------------------- | --- |\n+| **1.1 Project Mining**                            | Mine version control or library distribution platforms for projects using your software version |\n+| **1.2 Analyse Usage per Project**                 | Create library usage graphs of user projects |\n+| **1.3 Find Usage Patterns across all Projects**   | Find common library usage patterns across usage graphs |\n+| **1.4 Filter Found Patterns**                     | Filter relevant library usage patterns |\n+| **1.5 Generate Tests**                            | Generate regressions tests for library usage patterns |\n+\n+#### 1.1 Project Mining\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Mine version control or library distribution platforms for projects using your software version |\n+| Interface          | `org.cafejojo.schaapi.pipeline.ProjectMiner` |\n+| Implementations    | |\n+\n+#### 1.2 Analyse Usage per Project\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Create library usage graphs of user projects |\n+| Interface          | `org.cafejojo.schaapi.pipeline.LibraryUsageGraphGenerator` |\n+| Implementations    | **[Jimple Library Usage Graph Generator](https://github.com/cafejojo/schaapi/tree/master/modules/pipeline/jimple-library-usage-graph-generator)**<br>Generates library usage graphs for Java using [Soot](https://github.com/Sable/soot) Jimple control flow graphs. |\n+\n+#### 1.3 Find Usage Patterns across all Projects\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Find common library usage patterns across usage graphs |\n+| Interface          | `org.cafejojo.schaapi.pipeline.PatternDetector` |\n+| Implementations    | **[PrefixSpan Pattern Detector](https://github.com/cafejojo/schaapi/tree/master/modules/pipeline/prefix-span-pattern-detector)**<br>Identifies frequent sequential patterns in graphs, with the [PrefixSpan](https://ieeexplore.ieee.org/abstract/document/1339268/) algorithm. |\n+\n+#### 1.4 Filter Found Patterns\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Filter relevant library usage patterns |\n+| Interface          | `org.cafejojo.schaapi.pipeline.PatternFilterRule` |\n+| Implementations    | **[Jimple Pattern Filters](https://github.com/cafejojo/schaapi/tree/master/modules/pipeline/jimple-pattern-filter)**<br>Collection of filters that work with [Soot](https://github.com/Sable/soot) Jimple based library usage graphs. |\n+\n+#### 1.5 Generate Tests\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Generate regressions tests for library usage patterns |\n+| Interface          | `org.cafejojo.schaapi.pipeline.TestGenerator` |\n+| Implementations    | **[Jimple EvoSuite Test Generator](https://github.com/cafejojo/schaapi/tree/master/modules/pipeline/jimple-evosuite-test-generator)**<br>Generates testable classes based on [Soot](https://github.com/Sable/soot) Jimple based patterns, and generates tests for those using [EvoSuite](http://www.evosuite.org/). |\n+\n+### 2 Continuous Integration\n+| Stage                      | Description |\n+| -------------------------- | --- |\n+| **2.1 Execute Tests**      | Run generated tests against new library versions |\n+| **2.2 Notify Developers**  | Notify library developer of possibly affected users |\n+| **2.3 Notify Users**       | Notify library users of breaking changes |\n+\n+#### 2.1 Execute Tests\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Run generated tests against new library versions |\n+| Interface          | `--` |\n+| Implementations    | |\n+\n+#### 2.2 Notify Developers\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Notify library developer of possibly affected users |\n+| Interface          | `--` |\n+| Implementations    | |\n+\n+#### 2.3 Notify Users\n+| | |\n+| ------------------ | ------------- |\n+| Description        | Notify library users of breaking changes |\n+| Interface          | `--` |\n+| Implementations    | |\n+\n+## Changelog\n+Please see [releases](../../releases) for more information on what has changed recently.\n+\n+## Testing\n+``` bash\n+$ ./gradlew check\n+```\n+\n+## Contributing\n+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.\n+\n+## Security\n+If you discover any security related issues, please email cafejojo@casperboone.nl instead of using the issue tracker.\n+\n+## Credits\n+- [Joël Abrahams](https://github.com/jsabrahams)\n+- [Georgios Andreadis](https://github.com/gandreadis)\n+- [Casper Boone](https://github.com/casperboone)\n+- [Felix Dekker](https://github.com/fwdekker)\n+- [All Contributors](../../contributors)\n+\n+## License\n+The MIT License (MIT). Please see the [license file](LICENSE.md) for more information.","path":"README.md","position":129,"original_position":129,"commit_id":"d9a4b74575f52e19366362eb564628cb81ef5cd4","original_commit_id":"d9a4b74575f52e19366362eb564628cb81ef5cd4","user":{"login":"JSAbrahams","id":15815380,"avatar_url":"https://avatars2.githubusercontent.com/u/15815380?v=4","gravatar_id":"","url":"https://api.github.com/users/JSAbrahams","html_url":"https://github.com/JSAbrahams","followers_url":"https://api.github.com/users/JSAbrahams/followers","following_url":"https://api.github.com/users/JSAbrahams/following{/other_user}","gists_url":"https://api.github.com/users/JSAbrahams/gists{/gist_id}","starred_url":"https://api.github.com/users/JSAbrahams/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JSAbrahams/subscriptions","organizations_url":"https://api.github.com/users/JSAbrahams/orgs","repos_url":"https://api.github.com/users/JSAbrahams/repos","events_url":"https://api.github.com/users/JSAbrahams/events{/privacy}","received_events_url":"https://api.github.com/users/JSAbrahams/received_events","type":"User","site_admin":false},"body":"Hmmm this link doesn't work","created_at":"2018-05-21T15:25:13Z","updated_at":"2018-05-21T15:26:40Z","html_url":"https://github.com/cafejojo/schaapi/pull/103#discussion_r189623632","pull_request_url":"https://api.github.com/repos/cafejojo/schaapi/pulls/103","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/cafejojo/schaapi/pulls/comments/189623632"},"html":{"href":"https://github.com/cafejojo/schaapi/pull/103#discussion_r189623632"},"pull_request":{"href":"https://api.github.com/repos/cafejojo/schaapi/pulls/103"}}},"pull_request":{"url":"https://api.github.com/repos/cafejojo/schaapi/pulls/103","id":189409470,"html_url":"https://github.com/cafejojo/schaapi/pull/103","diff_url":"https://github.com/cafejojo/schaapi/pull/103.diff","patch_url":"https://github.com/cafejojo/schaapi/pull/103.patch","issue_url":"https://api.github.com/repos/cafejojo/schaapi/issues/103","number":103,"state":"open","locked":false,"title":"Add README contents","user":{"login":"casperboone","id":15815208,"avatar_url":"https://avatars2.githubusercontent.com/u/15815208?v=4","gravatar_id":"","url":"https://api.github.com/users/casperboone","html_url":"https://github.com/casperboone","followers_url":"https://api.github.com/users/casperboone/followers","following_url":"https://api.github.com/users/casperboone/following{/other_user}","gists_url":"https://api.github.com/users/casperboone/gists{/gist_id}","starred_url":"https://api.github.com/users/casperboone/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/casperboone/subscriptions","organizations_url":"https://api.github.com/users/casperboone/orgs","repos_url":"https://api.github.com/users/casperboone/repos","events_url":"https://api.github.com/users/casperboone/events{/privacy}","received_events_url":"https://api.github.com/users/casperboone/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-05-21T15:19:56Z","updated_at":"2018-05-21T15:26:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"fa7046a7bab4f86151811f4a58db85e475ca733e","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/cafejojo/schaapi/pulls/103/commits","review_comments_url":"https://api.github.com/repos/cafejojo/schaapi/pulls/103/comments","review_comment_url":"https://api.github.com/repos/cafejojo/schaapi/pulls/comments{/number}","comments_url":"https://api.github.com/repos/cafejojo/schaapi/issues/103/comments","statuses_url":"https://api.github.com/repos/cafejojo/schaapi/statuses/d9a4b74575f52e19366362eb564628cb81ef5cd4","head":{"label":"cafejojo:add-readme","ref":"add-readme","sha":"d9a4b74575f52e19366362eb564628cb81ef5cd4","user":{"login":"cafejojo","id":38208512,"avatar_url":"https://avatars3.githubusercontent.com/u/38208512?v=4","gravatar_id":"","url":"https://api.github.com/users/cafejojo","html_url":"https://github.com/cafejojo","followers_url":"https://api.github.com/users/cafejojo/followers","following_url":"https://api.github.com/users/cafejojo/following{/other_user}","gists_url":"https://api.github.com/users/cafejojo/gists{/gist_id}","starred_url":"https://api.github.com/users/cafejojo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cafejojo/subscriptions","organizations_url":"https://api.github.com/users/cafejojo/orgs","repos_url":"https://api.github.com/users/cafejojo/repos","events_url":"https://api.github.com/users/cafejojo/events{/privacy}","received_events_url":"https://api.github.com/users/cafejojo/received_events","type":"Organization","site_admin":false},"repo":{"id":130986816,"name":"schaapi","full_name":"cafejojo/schaapi","owner":{"login":"cafejojo","id":38208512,"avatar_url":"https://avatars3.githubusercontent.com/u/38208512?v=4","gravatar_id":"","url":"https://api.github.com/users/cafejojo","html_url":"https://github.com/cafejojo","followers_url":"https://api.github.com/users/cafejojo/followers","following_url":"https://api.github.com/users/cafejojo/following{/other_user}","gists_url":"https://api.github.com/users/cafejojo/gists{/gist_id}","starred_url":"https://api.github.com/users/cafejojo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cafejojo/subscriptions","organizations_url":"https://api.github.com/users/cafejojo/orgs","repos_url":"https://api.github.com/users/cafejojo/repos","events_url":"https://api.github.com/users/cafejojo/events{/privacy}","received_events_url":"https://api.github.com/users/cafejojo/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/cafejojo/schaapi","description":"🐑 Safe Changes for APIs","fork":false,"url":"https://api.github.com/repos/cafejojo/schaapi","forks_url":"https://api.github.com/repos/cafejojo/schaapi/forks","keys_url":"https://api.github.com/repos/cafejojo/schaapi/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cafejojo/schaapi/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cafejojo/schaapi/teams","hooks_url":"https://api.github.com/repos/cafejojo/schaapi/hooks","issue_events_url":"https://api.github.com/repos/cafejojo/schaapi/issues/events{/number}","events_url":"https://api.github.com/repos/cafejojo/schaapi/events","assignees_url":"https://api.github.com/repos/cafejojo/schaapi/assignees{/user}","branches_url":"https://api.github.com/repos/cafejojo/schaapi/branches{/branch}","tags_url":"https://api.github.com/repos/cafejojo/schaapi/tags","blobs_url":"https://api.github.com/repos/cafejojo/schaapi/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cafejojo/schaapi/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cafejojo/schaapi/git/refs{/sha}","trees_url":"https://api.github.com/repos/cafejojo/schaapi/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cafejojo/schaapi/statuses/{sha}","languages_url":"https://api.github.com/repos/cafejojo/schaapi/languages","stargazers_url":"https://api.github.com/repos/cafejojo/schaapi/stargazers","contributors_url":"https://api.github.com/repos/cafejojo/schaapi/contributors","subscribers_url":"https://api.github.com/repos/cafejojo/schaapi/subscribers","subscription_url":"https://api.github.com/repos/cafejojo/schaapi/subscription","commits_url":"https://api.github.com/repos/cafejojo/schaapi/commits{/sha}","git_commits_url":"https://api.github.com/repos/cafejojo/schaapi/git/commits{/sha}","comments_url":"https://api.github.com/repos/cafejojo/schaapi/comments{/number}","issue_comment_url":"https://api.github.com/repos/cafejojo/schaapi/issues/comments{/number}","contents_url":"https://api.github.com/repos/cafejojo/schaapi/contents/{+path}","compare_url":"https://api.github.com/repos/cafejojo/schaapi/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cafejojo/schaapi/merges","archive_url":"https://api.github.com/repos/cafejojo/schaapi/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cafejojo/schaapi/downloads","issues_url":"https://api.github.com/repos/cafejojo/schaapi/issues{/number}","pulls_url":"https://api.github.com/repos/cafejojo/schaapi/pulls{/number}","milestones_url":"https://api.github.com/repos/cafejojo/schaapi/milestones{/number}","notifications_url":"https://api.github.com/repos/cafejojo/schaapi/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cafejojo/schaapi/labels{/name}","releases_url":"https://api.github.com/repos/cafejojo/schaapi/releases{/id}","deployments_url":"https://api.github.com/repos/cafejojo/schaapi/deployments","created_at":"2018-04-25T10:00:57Z","updated_at":"2018-05-21T14:41:32Z","pushed_at":"2018-05-21T15:26:29Z","git_url":"git://github.com/cafejojo/schaapi.git","ssh_url":"git@github.com:cafejojo/schaapi.git","clone_url":"https://github.com/cafejojo/schaapi.git","svn_url":"https://github.com/cafejojo/schaapi","homepage":"","size":9670,"stargazers_count":5,"watchers_count":5,"language":"Kotlin","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"archived":false,"open_issues_count":4,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":1,"open_issues":4,"watchers":5,"default_branch":"master"}},"base":{"label":"cafejojo:master","ref":"master","sha":"7a618d6fe3896b69d82ac257dea2f4811e3ef159","user":{"login":"cafejojo","id":38208512,"avatar_url":"https://avatars3.githubusercontent.com/u/38208512?v=4","gravatar_id":"","url":"https://api.github.com/users/cafejojo","html_url":"https://github.com/cafejojo","followers_url":"https://api.github.com/users/cafejojo/followers","following_url":"https://api.github.com/users/cafejojo/following{/other_user}","gists_url":"https://api.github.com/users/cafejojo/gists{/gist_id}","starred_url":"https://api.github.com/users/cafejojo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cafejojo/subscriptions","organizations_url":"https://api.github.com/users/cafejojo/orgs","repos_url":"https://api.github.com/users/cafejojo/repos","events_url":"https://api.github.com/users/cafejojo/events{/privacy}","received_events_url":"https://api.github.com/users/cafejojo/received_events","type":"Organization","site_admin":false},"repo":{"id":130986816,"name":"schaapi","full_name":"cafejojo/schaapi","owner":{"login":"cafejojo","id":38208512,"avatar_url":"https://avatars3.githubusercontent.com/u/38208512?v=4","gravatar_id":"","url":"https://api.github.com/users/cafejojo","html_url":"https://github.com/cafejojo","followers_url":"https://api.github.com/users/cafejojo/followers","following_url":"https://api.github.com/users/cafejojo/following{/other_user}","gists_url":"https://api.github.com/users/cafejojo/gists{/gist_id}","starred_url":"https://api.github.com/users/cafejojo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cafejojo/subscriptions","organizations_url":"https://api.github.com/users/cafejojo/orgs","repos_url":"https://api.github.com/users/cafejojo/repos","events_url":"https://api.github.com/users/cafejojo/events{/privacy}","received_events_url":"https://api.github.com/users/cafejojo/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/cafejojo/schaapi","description":"🐑 Safe Changes for APIs","fork":false,"url":"https://api.github.com/repos/cafejojo/schaapi","forks_url":"https://api.github.com/repos/cafejojo/schaapi/forks","keys_url":"https://api.github.com/repos/cafejojo/schaapi/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cafejojo/schaapi/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cafejojo/schaapi/teams","hooks_url":"https://api.github.com/repos/cafejojo/schaapi/hooks","issue_events_url":"https://api.github.com/repos/cafejojo/schaapi/issues/events{/number}","events_url":"https://api.github.com/repos/cafejojo/schaapi/events","assignees_url":"https://api.github.com/repos/cafejojo/schaapi/assignees{/user}","branches_url":"https://api.github.com/repos/cafejojo/schaapi/branches{/branch}","tags_url":"https://api.github.com/repos/cafejojo/schaapi/tags","blobs_url":"https://api.github.com/repos/cafejojo/schaapi/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cafejojo/schaapi/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cafejojo/schaapi/git/refs{/sha}","trees_url":"https://api.github.com/repos/cafejojo/schaapi/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cafejojo/schaapi/statuses/{sha}","languages_url":"https://api.github.com/repos/cafejojo/schaapi/languages","stargazers_url":"https://api.github.com/repos/cafejojo/schaapi/stargazers","contributors_url":"https://api.github.com/repos/cafejojo/schaapi/contributors","subscribers_url":"https://api.github.com/repos/cafejojo/schaapi/subscribers","subscription_url":"https://api.github.com/repos/cafejojo/schaapi/subscription","commits_url":"https://api.github.com/repos/cafejojo/schaapi/commits{/sha}","git_commits_url":"https://api.github.com/repos/cafejojo/schaapi/git/commits{/sha}","comments_url":"https://api.github.com/repos/cafejojo/schaapi/comments{/number}","issue_comment_url":"https://api.github.com/repos/cafejojo/schaapi/issues/comments{/number}","contents_url":"https://api.github.com/repos/cafejojo/schaapi/contents/{+path}","compare_url":"https://api.github.com/repos/cafejojo/schaapi/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cafejojo/schaapi/merges","archive_url":"https://api.github.com/repos/cafejojo/schaapi/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cafejojo/schaapi/downloads","issues_url":"https://api.github.com/repos/cafejojo/schaapi/issues{/number}","pulls_url":"https://api.github.com/repos/cafejojo/schaapi/pulls{/number}","milestones_url":"https://api.github.com/repos/cafejojo/schaapi/milestones{/number}","notifications_url":"https://api.github.com/repos/cafejojo/schaapi/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cafejojo/schaapi/labels{/name}","releases_url":"https://api.github.com/repos/cafejojo/schaapi/releases{/id}","deployments_url":"https://api.github.com/repos/cafejojo/schaapi/deployments","created_at":"2018-04-25T10:00:57Z","updated_at":"2018-05-21T14:41:32Z","pushed_at":"2018-05-21T15:26:29Z","git_url":"git://github.com/cafejojo/schaapi.git","ssh_url":"git@github.com:cafejojo/schaapi.git","clone_url":"https://github.com/cafejojo/schaapi.git","svn_url":"https://github.com/cafejojo/schaapi","homepage":"","size":9670,"stargazers_count":5,"watchers_count":5,"language":"Kotlin","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"archived":false,"open_issues_count":4,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":1,"open_issues":4,"watchers":5,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/cafejojo/schaapi/pulls/103"},"html":{"href":"https://github.com/cafejojo/schaapi/pull/103"},"issue":{"href":"https://api.github.com/repos/cafejojo/schaapi/issues/103"},"comments":{"href":"https://api.github.com/repos/cafejojo/schaapi/issues/103/comments"},"review_comments":{"href":"https://api.github.com/repos/cafejojo/schaapi/pulls/103/comments"},"review_comment":{"href":"https://api.github.com/repos/cafejojo/schaapi/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/cafejojo/schaapi/pulls/103/commits"},"statuses":{"href":"https://api.github.com/repos/cafejojo/schaapi/statuses/d9a4b74575f52e19366362eb564628cb81ef5cd4"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"JSAbrahams"}}