{"action":"created","comment":{"url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/comments/219728252","pull_request_review_id":157971007,"id":219728252,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIxOTcyODI1Mg==","diff_hunk":"@@ -0,0 +1,141 @@\n+# Cerberus Gradle Plugin\n+\n+Konrad Biernacki, 2018\n+\n+## About\n+\n+Cerberus is a gradle plugin for extracting Jira issues from commit messages and sharing information on its respective Jenkins job and HockeyApp upload. \n+It can generate release notes for use by HockeyApp, and produce Jira comments with Jenkins build and HockeyApp artefact information.\n+\n+Using all of Cerberus' features, you can use your commit history -\n+``` \n+ * HEAD -> Develop\n+ | \\ \n+ *   \\\n+ | \\ |\n+ | | * [CER-12] Address PR Feedback\n+ | | * [CER-12] Fix bug\n+ | | | \n+ | * | [CER-7] Add feature\n+ | / |\n+```\n+\n+to generate release notes using data from Jira and your build -\n+```\n+### Changelog\n+- [CER-12] UI Bug\n+- [CER-7] Minor Feature\n+\n+Built by [Jenkins](https://jenkins.url/build/451)\n+```\n+\n+and comment on your Jira tickets with build and artefact information\n+```\n+Jenkins: [Build #451|https://jenkins.url/build/451]\n+HockeyApp: [Version 2.0-RC|https://hockey.url/app/d3adcaf3]\n+```\n+\n+## Installation\n+\n+### As a buildSrc Plugin\n+\n+1. If you don't have one already, create a `buildSrc` folder in your target project's root directory\n+2. Copy this project into the `buildSrc` directory (so the plugin `build.gradle` file would be found in `target_project/buildSrc/build.gradle`)\n+\n+### As a JAR Plugin\n+\n+1. Compile the plugin as a `.jar` file\n+2. Add the `.jar` to your target project (eg. `target_project/libs/cerberus.jar`)\n+3. Add the following to your target project's `build.gradle` file:\n+    ```groovy\n+    buildscript {\n+        dependencies {\n+            classpath files('libs/cerberus.jar')\n+        }\n+    }\n+    ```\n+\n+## Usage\n+\n+1. Add the plugin to your target project's `build.gradle`\n+    ```groovy\n+    apply plugin: 'com.outware.omproject.cerberus'\n+    ```\n+2. Specify any configuration parameters in the Gradle DSL plugin configuration block. A typical implementation could be as follows:\n+    ```groovy\n+    cerberus {\n+        shouldUpdateTicketAfter = ['pushToHockeyApp']\n+        \n+        jiraDomain = 'https://jira.mydomain.com'\n+        jiraUsername = 'cerberus'\n+        jiraPassword = 'password'\n+    }\n+    ```\n+3. Use Cerberus' tasks in your target build flow\n+\n+    ```groovy\n+    task runCi {\n+        configure {\n+            group = 'Continuous Integration'\n+            description = \"Main CI Task\"\n+        }\n+    \n+        dependsOn('assemble', \n+                  'cerberus_makeReleaseNotes', \n+                  'pushToHockeyApp', \n+                  'cerberus_updateTicket')\n+    }\n+    ```\n+\n+## Gradle Tasks\n+\n+Cerberus adds the following tasks to your project classpath:\n+\n+`cerberus_makeReleaseNotes`\n+- Generate release notes from all changes between the HEAD and a specified SHA-1 (`cerberus.lastSuccessfulCommit`)\n+- Load those changes into the plugin extension at `cerberus.releaseNotes` as a markdown formatted string\n+\n+`cerberus_updateTicket`\n+- Comment on any identified Jira tickets with:\n+    - Build information\n+        - `cerberus.buildNumber`\n+        - `cerberus.buildUrl`\n+    - HockeyApp upload information\n+        - `cerberus.hockeyAppUploadUrl`\n+        - `cerberus.hockeyAppShortVersion`\n+\n+## Configuration\n+\n+The plugin extension available through the Gradle DSL is documented at `CerberusPluginExtension.kt`\n+\n+### Environment Variables\n+\n+Some configuration parameters are populated from environment variables\n+\n+| Parameter            | Environment Variable             | Description                                                |\n+|----------------------|----------------------------------|------------------------------------------------------------|\n+| jiraDomain           | `CI_USER_JIRA_URL`               | URL to Jira instance                                       |\n+| jiraUsername         | `CI_USER_JIRA_CREDENTIALS_USR`   | Username for Jira instance                                 |","path":"README.md","position":118,"original_position":118,"commit_id":"c456c5dd1d7c4b8956dc6e1be38d63eb73b7f88f","original_commit_id":"c456c5dd1d7c4b8956dc6e1be38d63eb73b7f88f","user":{"login":"kgbier","id":9250604,"node_id":"MDQ6VXNlcjkyNTA2MDQ=","avatar_url":"https://avatars2.githubusercontent.com/u/9250604?v=4","gravatar_id":"","url":"https://api.github.com/users/kgbier","html_url":"https://github.com/kgbier","followers_url":"https://api.github.com/users/kgbier/followers","following_url":"https://api.github.com/users/kgbier/following{/other_user}","gists_url":"https://api.github.com/users/kgbier/gists{/gist_id}","starred_url":"https://api.github.com/users/kgbier/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kgbier/subscriptions","organizations_url":"https://api.github.com/users/kgbier/orgs","repos_url":"https://api.github.com/users/kgbier/repos","events_url":"https://api.github.com/users/kgbier/events{/privacy}","received_events_url":"https://api.github.com/users/kgbier/received_events","type":"User","site_admin":false},"body":"In my case, since environment variables are a convenience more than anything else, would we consider removing any other env vars? I think other generic ones such as `buildNumber` and `lastSuccessfulCommit` (while are still coming from Jenkins) still make sense.","created_at":"2018-09-24T04:28:31Z","updated_at":"2018-09-24T04:28:31Z","html_url":"https://github.com/outware/gradle-plugin-cerberus/pull/1#discussion_r219728252","pull_request_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/comments/219728252"},"html":{"href":"https://github.com/outware/gradle-plugin-cerberus/pull/1#discussion_r219728252"},"pull_request":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1"}},"in_reply_to_id":219724492},"pull_request":{"url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1","id":217175109,"node_id":"MDExOlB1bGxSZXF1ZXN0MjE3MTc1MTA5","html_url":"https://github.com/outware/gradle-plugin-cerberus/pull/1","diff_url":"https://github.com/outware/gradle-plugin-cerberus/pull/1.diff","patch_url":"https://github.com/outware/gradle-plugin-cerberus/pull/1.patch","issue_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues/1","number":1,"state":"open","locked":false,"title":"Add a Readme","user":{"login":"kgbier","id":9250604,"node_id":"MDQ6VXNlcjkyNTA2MDQ=","avatar_url":"https://avatars2.githubusercontent.com/u/9250604?v=4","gravatar_id":"","url":"https://api.github.com/users/kgbier","html_url":"https://github.com/kgbier","followers_url":"https://api.github.com/users/kgbier/followers","following_url":"https://api.github.com/users/kgbier/following{/other_user}","gists_url":"https://api.github.com/users/kgbier/gists{/gist_id}","starred_url":"https://api.github.com/users/kgbier/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kgbier/subscriptions","organizations_url":"https://api.github.com/users/kgbier/orgs","repos_url":"https://api.github.com/users/kgbier/repos","events_url":"https://api.github.com/users/kgbier/events{/privacy}","received_events_url":"https://api.github.com/users/kgbier/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-09-21T05:28:53Z","updated_at":"2018-09-24T04:28:31Z","closed_at":null,"merged_at":null,"merge_commit_sha":"12a0c13c48e6da907c29917e0f9a3a22c60ab15e","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1/commits","review_comments_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1/comments","review_comment_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/comments{/number}","comments_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues/1/comments","statuses_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/statuses/c456c5dd1d7c4b8956dc6e1be38d63eb73b7f88f","head":{"label":"kgbier:feature/init_readme","ref":"feature/init_readme","sha":"c456c5dd1d7c4b8956dc6e1be38d63eb73b7f88f","user":{"login":"kgbier","id":9250604,"node_id":"MDQ6VXNlcjkyNTA2MDQ=","avatar_url":"https://avatars2.githubusercontent.com/u/9250604?v=4","gravatar_id":"","url":"https://api.github.com/users/kgbier","html_url":"https://github.com/kgbier","followers_url":"https://api.github.com/users/kgbier/followers","following_url":"https://api.github.com/users/kgbier/following{/other_user}","gists_url":"https://api.github.com/users/kgbier/gists{/gist_id}","starred_url":"https://api.github.com/users/kgbier/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kgbier/subscriptions","organizations_url":"https://api.github.com/users/kgbier/orgs","repos_url":"https://api.github.com/users/kgbier/repos","events_url":"https://api.github.com/users/kgbier/events{/privacy}","received_events_url":"https://api.github.com/users/kgbier/received_events","type":"User","site_admin":false},"repo":{"id":149712741,"node_id":"MDEwOlJlcG9zaXRvcnkxNDk3MTI3NDE=","name":"gradle-plugin-cerberus","full_name":"kgbier/gradle-plugin-cerberus","private":false,"owner":{"login":"kgbier","id":9250604,"node_id":"MDQ6VXNlcjkyNTA2MDQ=","avatar_url":"https://avatars2.githubusercontent.com/u/9250604?v=4","gravatar_id":"","url":"https://api.github.com/users/kgbier","html_url":"https://github.com/kgbier","followers_url":"https://api.github.com/users/kgbier/followers","following_url":"https://api.github.com/users/kgbier/following{/other_user}","gists_url":"https://api.github.com/users/kgbier/gists{/gist_id}","starred_url":"https://api.github.com/users/kgbier/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kgbier/subscriptions","organizations_url":"https://api.github.com/users/kgbier/orgs","repos_url":"https://api.github.com/users/kgbier/repos","events_url":"https://api.github.com/users/kgbier/events{/privacy}","received_events_url":"https://api.github.com/users/kgbier/received_events","type":"User","site_admin":false},"html_url":"https://github.com/kgbier/gradle-plugin-cerberus","description":"Improve traceability in your build chain using gradle","fork":true,"url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus","forks_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/forks","keys_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/teams","hooks_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/hooks","issue_events_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/issues/events{/number}","events_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/events","assignees_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/assignees{/user}","branches_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/branches{/branch}","tags_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/tags","blobs_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/git/refs{/sha}","trees_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/statuses/{sha}","languages_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/languages","stargazers_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/stargazers","contributors_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/contributors","subscribers_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/subscribers","subscription_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/subscription","commits_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/commits{/sha}","git_commits_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/git/commits{/sha}","comments_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/comments{/number}","issue_comment_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/issues/comments{/number}","contents_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/contents/{+path}","compare_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/merges","archive_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/downloads","issues_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/issues{/number}","pulls_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/pulls{/number}","milestones_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/milestones{/number}","notifications_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/labels{/name}","releases_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/releases{/id}","deployments_url":"https://api.github.com/repos/kgbier/gradle-plugin-cerberus/deployments","created_at":"2018-09-21T05:08:56Z","updated_at":"2018-09-24T04:01:40Z","pushed_at":"2018-09-24T04:01:39Z","git_url":"git://github.com/kgbier/gradle-plugin-cerberus.git","ssh_url":"git@github.com:kgbier/gradle-plugin-cerberus.git","clone_url":"https://github.com/kgbier/gradle-plugin-cerberus.git","svn_url":"https://github.com/kgbier/gradle-plugin-cerberus","homepage":"","size":109,"stargazers_count":0,"watchers_count":0,"language":"Kotlin","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"develop"}},"base":{"label":"outware:develop","ref":"develop","sha":"a0e64712a4f1af6610d0c170cdc9a9f3d639421a","user":{"login":"outware","id":5234807,"node_id":"MDEyOk9yZ2FuaXphdGlvbjUyMzQ4MDc=","avatar_url":"https://avatars0.githubusercontent.com/u/5234807?v=4","gravatar_id":"","url":"https://api.github.com/users/outware","html_url":"https://github.com/outware","followers_url":"https://api.github.com/users/outware/followers","following_url":"https://api.github.com/users/outware/following{/other_user}","gists_url":"https://api.github.com/users/outware/gists{/gist_id}","starred_url":"https://api.github.com/users/outware/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/outware/subscriptions","organizations_url":"https://api.github.com/users/outware/orgs","repos_url":"https://api.github.com/users/outware/repos","events_url":"https://api.github.com/users/outware/events{/privacy}","received_events_url":"https://api.github.com/users/outware/received_events","type":"Organization","site_admin":false},"repo":{"id":149710469,"node_id":"MDEwOlJlcG9zaXRvcnkxNDk3MTA0Njk=","name":"gradle-plugin-cerberus","full_name":"outware/gradle-plugin-cerberus","private":false,"owner":{"login":"outware","id":5234807,"node_id":"MDEyOk9yZ2FuaXphdGlvbjUyMzQ4MDc=","avatar_url":"https://avatars0.githubusercontent.com/u/5234807?v=4","gravatar_id":"","url":"https://api.github.com/users/outware","html_url":"https://github.com/outware","followers_url":"https://api.github.com/users/outware/followers","following_url":"https://api.github.com/users/outware/following{/other_user}","gists_url":"https://api.github.com/users/outware/gists{/gist_id}","starred_url":"https://api.github.com/users/outware/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/outware/subscriptions","organizations_url":"https://api.github.com/users/outware/orgs","repos_url":"https://api.github.com/users/outware/repos","events_url":"https://api.github.com/users/outware/events{/privacy}","received_events_url":"https://api.github.com/users/outware/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/outware/gradle-plugin-cerberus","description":"Improve traceability in your build chain using gradle","fork":false,"url":"https://api.github.com/repos/outware/gradle-plugin-cerberus","forks_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/forks","keys_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/keys{/key_id}","collaborators_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/teams","hooks_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/hooks","issue_events_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues/events{/number}","events_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/events","assignees_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/assignees{/user}","branches_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/branches{/branch}","tags_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/tags","blobs_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/git/refs{/sha}","trees_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/git/trees{/sha}","statuses_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/statuses/{sha}","languages_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/languages","stargazers_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/stargazers","contributors_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/contributors","subscribers_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/subscribers","subscription_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/subscription","commits_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/commits{/sha}","git_commits_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/git/commits{/sha}","comments_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/comments{/number}","issue_comment_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues/comments{/number}","contents_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/contents/{+path}","compare_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/compare/{base}...{head}","merges_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/merges","archive_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/downloads","issues_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues{/number}","pulls_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls{/number}","milestones_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/milestones{/number}","notifications_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/labels{/name}","releases_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/releases{/id}","deployments_url":"https://api.github.com/repos/outware/gradle-plugin-cerberus/deployments","created_at":"2018-09-21T04:37:08Z","updated_at":"2018-09-24T03:23:33Z","pushed_at":"2018-09-24T03:23:32Z","git_url":"git://github.com/outware/gradle-plugin-cerberus.git","ssh_url":"git@github.com:outware/gradle-plugin-cerberus.git","clone_url":"https://github.com/outware/gradle-plugin-cerberus.git","svn_url":"https://github.com/outware/gradle-plugin-cerberus","homepage":"","size":92,"stargazers_count":2,"watchers_count":2,"language":"Kotlin","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":3,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":2,"open_issues":3,"watchers":2,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1"},"html":{"href":"https://github.com/outware/gradle-plugin-cerberus/pull/1"},"issue":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues/1"},"comments":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/issues/1/comments"},"review_comments":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1/comments"},"review_comment":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/pulls/1/commits"},"statuses":{"href":"https://api.github.com/repos/outware/gradle-plugin-cerberus/statuses/c456c5dd1d7c4b8956dc6e1be38d63eb73b7f88f"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"kgbier"}}