fastlane-plugin-cerberus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4384ba7a06799192ab423761428aebd7a184f4da
+  data.tar.gz: a35a36e207969e6bb02d68ff294cba41c48485a6
+SHA512:
+  metadata.gz: b202049fd673336638c9393c60d6b85bb168710018050abaa1200a80b4669876e031c6180baf9246fd6523d496a4b5403874ddfb1030be6303d30f04237bb5ca
+  data.tar.gz: 7a061e61ef221aa0c3e5be3143fcbca561acfb5e8c789deaff85d2e04678e8028caca7181329ee39e42b70d2bbb09977c59e9585c3be1c6d92376d1f3f21429a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Harry Singh <harry.singh@outware.com.au>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,257 @@
+# Cerberus
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-cerberus) [![CircleCI](https://circleci.com/gh/outware/fastlane-plugin-cerberus.svg?style=svg)](https://circleci.com/gh/outware/fastlane-plugin-cerberus)
+
+* [Getting Started](#getting-started)
+* [About](#about)
+* [Integration Guide](#integration-guide)
+* [Actions](#actions)
+  + [find_tickets](#find_tickets)
+  + [find_commits](#find_commits)
+  + [jira_comment](#jira_comment)
+  + [release_notes](#release_notes)
+* [Example](#example)
+* [Run tests for this plugin](#run-tests-for-this-plugin)
+* [Issues and Feedback](#issues-and-feedback)
+* [Troubleshooting](#troubleshooting)
+* [Using _fastlane_ Plugins](#using-_fastlane_-plugins)
+* [About _fastlane_](#about-_fastlane_)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-cerberus`, add it to your project by running:
+
+```bash
+fastlane add_plugin cerberus
+```
+
+## About
+
+Cerberus is a fastlane plugin for extracting Jira issues from commit messages and sharing information on its respective Jenkins job and HockeyApp upload.
+
+Using all of Cerberus' features, you can use your commit history -
+
+```
+ * HEAD -> Develop
+ | \
+ *   \
+ | \ |
+ | | * [CER-12] Address PR Feedback
+ | | * [CER-12] Fix bug
+ | | |
+ | * | [CER-7] Add feature
+ | / |
+```
+
+to generate release notes using data from Jira and your build -
+
+```
+### Changelog
+- [CER-12] UI Bug
+- [CER-7] Minor Feature
+
+Built by [Jenkins](https://jenkins.url/build/451)
+```
+
+and comment on your Jira tickets with build and artefact information
+
+```
+Jenkins: [Build #451|https://jenkins.url/build/451]
+HockeyApp: [Version 2.0-RC|https://hockey.url/app/d3adcaf3]
+```
+
+## Integration Guide
+
+Please take a look at the project [integration guide](INTEGRATION.md) to get you started.
+
+## Actions
+
+### [find_tickets](lib/fastlane/plugin/cerberus/actions/find_tickets_action.rb)
+
+This action will extract tickets using a provided regular expression. The default format is as follows:
+`ABC-123`, one or more capital letters, followed by a dash, followed by one or more digits.
+
+#### Parameters
+
+| Parameter     | Environment Name                  | Default Value                                         | Description                                                                   |
+|-----------    |-------------------------------    |---------------------------------------------------    |------------------------------------------------------------------------------ |
+| from          | FL_FIND_TICKETS_FROM              | `'HEAD'`                                              | The commit SHA of the first commit to parse for ticket information.           |
+| to            | FL_FIND_TICKETS_TO                | `ENV[GIT_PREVIOUS_SUCCESSFUL_COMMIT]` or `'HEAD'`     | The commit SHA of the last commit to parse for ticket information.            |
+| matching      | FL_FIND_TICKETS_MATCHING          | `'([A-Z]+-\d+)'`                                      | Regex which will be used to extract the tickets from the commit messages.     |
+| excluding     | FL_FIND_TICKETS_EXCLUDING         |                                                       | Additional regex to ignore specific commits or keywords.                      |
+| pretty        | FL_FIND_TICKETS_PRETTY_FORMAT     | `'* (%h) %s'`                                         | [A git log pretty format.](https://git-scm.com/docs/git-log#_pretty_formats)  |
+
+#### Usage
+
+```ruby
+find_tickets(
+ from: 'HEAD',
+ to: '81fae0ffcc714fb56a1c186ae7c73c80442fff74',
+ matching: '([A-Z]+-\d+)',
+ excluding: 'TECH',
+ pretty: '* (%h) %s'
+)
+```
+
+#### Result
+
+Returns an Array of Strings. e.g `["CER-1", "CER-2"]`
+
+---
+
+### [find_commits](lib/fastlane/plugin/cerberus/actions/find_commits_action.rb)
+
+Extracts the commit messages from a set of commits using regex.
+
+#### Parameters
+
+| Parameter     | Environment Name                  | Default Value                             | Description                                                                   |
+|-----------    |-------------------------------    |----------------------------------------   |------------------------------------------------------------------------------ |
+| from          | FL_FIND_COMMITS_FROM              | `ENV['FL_FIND_TICKETS_FROM']`             | The commit SHA of the first commit to parse for ticket information.           |
+| to            | FL_FIND_COMMITS_TO                | `ENV['FL_FIND_TICKETS_TO']`               | The commit SHA of the last commit to parse for ticket information.            |
+| matching      | FL_FIND_COMMITS_MATCHING          | `ENV['FL_FIND_TICKETS_MATCHING']`         | Regex which will be used to extract the tickets from the commit messages.     |
+| pretty        | FL_FIND_COMMITS_PRETTY_FORMAT     | `ENV['FL_FIND_TICKETS_PRETTY_FORMAT']`    | [A git log pretty format.](https://git-scm.com/docs/git-log#_pretty_formats)  |
+
+#### Usage
+
+```ruby
+find_commits(
+ from: 'HEAD',
+ to: '81fae0ffcc714fb56a1c186ae7c73c80442fff74',
+ matching: 'TECH',
+ pretty: '%s'
+)
+```
+
+#### Result
+
+Returns an Array of Strings. e.g `["[TECH] - Update SSL pinning"]`
+
+---
+
+### [jira_comment](lib/fastlane/plugin/cerberus/actions/jira_comment_action.rb)
+
+Adds a comment on the Jira isses with the CI build number and the link to the CI build it also adds a link to the HockeyApp build and its build number.
+
+#### Parameters
+
+| Parameter                 | Environment Name                  | Default Value                                                 | Description                                           |
+|-------------------------- |---------------------------------- |------------------------------------------------------------   |-----------------------------------------------------  |
+| issues                    | FL_JIRA_COMMENT_ISSUES            | `[]`                                                          | The Jira issues to comment on. An Array of Strings.   |
+| build_number              | FL_JIRA_COMMENT_BUILD_NUMBER      | `ENV['BUILD_NUMBER']`                                         | The CI build number that built the current changes.   |
+| build_url                 | FL_JIRA_COMMENT_BUILD_URL         | `ENV['BUILD_URL']`                                            | URL to the CI build.                                  |
+| app_version               | FL_JIRA_COMMENT_APP_VERSION       |                                                               | The current app version.                              |
+| hockey_url                | FL_JIRA_COMMENT_HOCKEY_URL        | `Actions.lane_context[SharedValues::HOCKEY_DOWNLOAD_LINK]`    | URL to the HockeyApp build.                           |
+| username                  | FL_JIRA_USERNAME                  |                                                               | Jira username.                                        |
+| password                  | FL_JIRA_PASSWORD                  |                                                               | Jira password.                                        |
+| host                      | FL_JIRA_HOST                      |                                                               | Jira host location.                                   |
+| context_path              | FL_JIRA_CONTEXT_PATH              | `''`                                                          | Jira context path.                                    |
+| disable_ssl_verification  | FL_JIRA_DISABLE_SSL_VERIFICATION  | `false`                                                       | Disable Jira SSL verification.                        |
+
+#### Usage
+
+```ruby
+jira_comment(
+ issues: ['CER-1', 'CER-2'],
+ build_number: '1',
+ build_url: 'https://www.jenkins.com/build/1',
+ app_version: '1.0-QA',
+ hockey_url: 'https://rink.hockeyapp.net/apps/32c5df727eac426',
+ username: 'jenkins',
+ password: 'XYZ123',
+ host: 'https://jira.com',
+ context_path: '',
+ disable_ssl_verification: false
+)
+```
+
+#### Result
+
+Adds a comment on all the issues provided which have an accociated Jira issue in the following format:
+
+```
+Jenkins: [Build ##{build_number}|#{build_url}]
+
+HockeyApp: [Version #{app_version} (#{build_number})|#{hockey_url}]
+```
+
+---
+
+### [release_notes](lib/fastlane/plugin/cerberus/actions/release_notes_action.rb)
+
+Generates a changelog containing all the completed issues and any additional messages to be included as part of the changelog. It sets the `FL_CHANGELOG` shared value with the changelog.
+
+#### Parameters
+
+| Parameter                 | Environment Name                      | Default Value         | Description                                                               |
+|-------------------------- |-----------------------------------    |--------------------   |-------------------------------------------------------------------------  |
+| issues                    | FL_RELEASE_NOTES_ISSUES               | `[]`                  | The Jira issues completed as part of this build. An Array of Strings.     |
+| include_commits           | FL_HOCKEY_COMMENT_INCLUDE_COMMITS     | `[]`                  | Additional commit messages to be included as part of the release notes.   |
+| build_url                 | FL_RELEASE_NOTES_BUILD_URL            | `ENV['BUILD_URL']`    | URL to the CI build.                                                      |
+| username                  | FL_JIRA_USERNAME                      |                       | Jira username.                                                            |
+| password                  | FL_JIRA_PASSWORD                      |                       | Jira password.                                                            |
+| host                      | FL_JIRA_HOST                          |                       | Jira host location.                                                       |
+| context_path              | FL_JIRA_CONTEXT_PATH                  | `''`                  | Jira context path.                                                        |
+| disable_ssl_verification  | FL_JIRA_DISABLE_SSL_VERIFICATION      | `false`               | Disable Jira SSL verification.                                            |
+
+#### Usage
+
+```ruby
+release_notes(
+ issues: ['CER-1', 'CER-2'],
+ include_commits: ["[TECH] - Add SSL"],
+ build_url: 'https://www.jenkins.com/build/1',
+ username: 'jenkins',
+ password: 'XYZ123',
+ host: 'https://jira.com',
+ context_path: '',
+ disable_ssl_verification: false
+)
+```
+
+#### Result
+
+Returns a String containing all the changes and additional messages in the following `markdown` format:
+```
+### Changelog
+
+- [CER-1](URL): Issue summary
+- TECH: Additional commit message
+
+Built by [Jenkins](URL)
+```
+
+---
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```bash
+rake
+```
+
+To automatically fix many of the styling issues, use
+```bash
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/cerberus.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/cerberus/version'
+
+module Fastlane
+  module Cerberus
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Cerberus.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/cerberus/actions/find_commits_action.rb

@@ -0,0 +1,100 @@
+module Fastlane
+  module Actions
+    class FindCommitsAction < Action
+      def self.run(params)
+        regex = Regexp.new(params[:matching])
+        changelog = log(from: params[:from], to: params[:to], pretty: params[:pretty])
+
+        if changelog.to_s.empty?
+          UI.important('No issues found.')
+          return []
+        end
+
+        tickets = tickets(log: changelog, regex: regex)
+        UI.important("Additional Issues: #{tickets.join("\n")}")
+        return tickets
+      end
+
+      #####################################################
+      # @!group Helpers
+      #####################################################
+
+      def self.log(from:, to:, pretty:)
+        if to.to_s.empty? || from.to_s.empty?
+          UI.important('Git Tickets: log(to:, from:) cannot be nil')
+          return nil
+        end
+
+        other_action.changelog_from_git_commits(
+          between: [from, to],
+          pretty: pretty,
+          merge_commit_filtering: :exclude_merges.to_s
+        )
+      end
+
+      def self.tickets(log:, regex:)
+        return [] if log.to_s.empty?
+
+        log.each_line
+           .map(&:strip)
+           .grep(regex)
+           .flatten
+           .reject(&:empty?)
+           .uniq
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.details
+        'Extracts additional issues from the log'
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.output
+        [String]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :from,
+            env_name: 'FL_FIND_COMMITS_FROM',
+            description:  'start commit',
+            optional: true,
+            default_value: ENV['FL_FIND_TICKETS_FROM'] || 'HEAD'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :to,
+            env_name: 'FL_FIND_COMMITS_TO',
+            description:  'end commit',
+            optional: true,
+            default_value: ENV['FL_FIND_TICKETS_TO'] || ENV['GIT_PREVIOUS_SUCCESSFUL_COMMIT'] || 'HEAD'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :matching,
+            env_name: 'FL_FIND_COMMITS_MATCHING',
+            description:  'regex to only include to the change log',
+            optional: true,
+            default_value: ENV['FL_FIND_TICKETS_MATCHING'] || '([A-Z]+-\d+)'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :pretty,
+            env_name: 'FL_FIND_COMMITS_PRETTY_FORMAT',
+            description:  'git pretty format',
+            optional: true,
+            default_value: ENV['FL_FIND_TICKETS_PRETTY_FORMAT'] || '%s'
+          )
+        ]
+      end
+
+      def self.author
+        'Syd Srirak <sydney.srirak@outware.com.au>'
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/cerberus/actions/find_tickets_action.rb

@@ -0,0 +1,114 @@
+require 'fastlane/action'
+require_relative '../helper/cerberus_helper'
+
+module Fastlane
+  module Actions
+    class FindTicketsAction < Action
+      def self.run(params)
+        regex = Regexp.new(params[:matching])
+        changelog = log(from: params[:from], to: params[:to], pretty: params[:pretty])
+
+        if changelog.to_s.empty?
+          UI.important('Git Tickets: No changes found.')
+          return []
+        end
+
+        tickets = tickets(log: changelog, regex: regex)
+        exclude_regex = Regexp.new(params[:excluding]) unless params[:excluding].to_s.empty?
+        tickets = filter_tickets(tickets: tickets, exclude_regex: exclude_regex) if exclude_regex
+        UI.important("Jira Issues: #{tickets.join(', ')}")
+        return tickets
+      end
+
+      #####################################################
+      # @!group Helpers
+      #####################################################
+
+      def self.log(from:, to:, pretty:)
+        if to.to_s.empty? || from.to_s.empty?
+          UI.important('Git Tickets: log(to:, from:) cannot be nil')
+          return nil
+        end
+
+        other_action.changelog_from_git_commits(
+          between: [from, to],
+          pretty: pretty,
+          merge_commit_filtering: :exclude_merges.to_s
+        )
+      end
+
+      def self.tickets(log:, regex:)
+        return [] if log.to_s.empty?
+        log.each_line
+           .map { |line| line.strip.scan(regex) }
+           .flatten
+           .reject(&:empty?)
+           .uniq
+      end
+
+      def self.filter_tickets(tickets:, exclude_regex:)
+        return [] if tickets.to_s.empty?
+        tickets.each.grep_v(exclude_regex)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.details
+        'Extracts the Jira issue keys between commits'
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.output
+        [String]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :from,
+            env_name: 'FL_FIND_TICKETS_FROM',
+            description:  'start commit',
+            optional: true,
+            default_value: 'HEAD'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :to,
+            env_name: 'FL_FIND_TICKETS_TO',
+            description:  'end commit',
+            optional: true,
+            default_value: ENV['GIT_PREVIOUS_SUCCESSFUL_COMMIT'] || 'HEAD'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :matching,
+            env_name: 'FL_FIND_TICKETS_MATCHING',
+            description:  'regex to extract ticket numbers',
+            optional: true,
+            default_value: '([A-Z]+-\d+)'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :excluding,
+            env_name: 'FL_FIND_TICKETS_EXCLUDING',
+            description:  'regex to exclude from the change log',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :pretty,
+            env_name: 'FL_FIND_TICKETS_PRETTY_FORMAT',
+            description:  'git pretty format',
+            optional: true,
+            default_value: '* (%h) %s'
+          )
+        ]
+      end
+
+      def self.author
+        'Harry Singh <hhs4harry@gmail.com>'
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/cerberus/actions/jira_comment_action.rb

@@ -0,0 +1,134 @@
+require 'fastlane/action'
+require_relative '../helper/cerberus_helper'
+
+module Fastlane
+  module Actions
+    class JiraCommentAction < Action
+      def self.run(params)
+        issues = params[:issues]
+        return if issues.to_a.empty?
+
+        jira_helper = Helper::CerberusHelper.jira_helper(
+          host: params[:host],
+          username: params[:username],
+          password: params[:password],
+          context_path: params[:context_path],
+          disable_ssl_verification: params[:disable_ssl_verification]
+        )
+        issues = jira_helper.get(issues: issues)
+
+        comment = generate_comment(
+          build_number: params[:build_number],
+          build_url: params[:build_url],
+          app_version: params[:app_version],
+          hockey_url: params[:hockey_url]
+        )
+
+        jira_helper.add_comment(
+          comment: comment,
+          issues: issues
+        )
+      end
+
+      #####################################################
+      # @!group Helpers
+      #####################################################
+
+      def self.generate_comment(build_number:, build_url:, app_version:, hockey_url:)
+        [
+          "Jenkins: [Build ##{build_number}|#{build_url}]",
+          "HockeyApp: [Version #{app_version} (#{build_number})|#{hockey_url}]"
+        ].join("\n")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.details
+        'This action adds comments on Jira issues with the current build number and url of that build'
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :issues,
+            env_name: 'FL_JIRA_COMMENT_ISSUES',
+            description:  'jira issue keys',
+            optional: true,
+            default_value: [],
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_number,
+            env_name: 'FL_JIRA_COMMENT_BUILD_NUMBER',
+            description:  'CI build number',
+            optional: true,
+            default_value: ENV['BUILD_NUMBER']
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_url,
+            env_name: 'FL_JIRA_COMMENT_BUILD_URL',
+            description:  'CI build URL',
+            optional: true,
+            default_value: ENV['BUILD_URL']
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :app_version,
+            env_name: 'FL_JIRA_COMMENT_APP_VERSION',
+            description:  'App version',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :hockey_url,
+            env_name: 'FL_JIRA_COMMENT_HOCKEY_URL',
+            description:  'Hockey build url',
+            optional: true,
+            default_value: Actions.lane_context[SharedValues::HOCKEY_DOWNLOAD_LINK]
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :username,
+            env_name: 'FL_JIRA_USERNAME',
+            description:  'Jira user',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :password,
+            env_name: 'FL_JIRA_PASSWORD',
+            description:  'Jira user',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :host,
+            env_name: 'FL_JIRA_HOST',
+            description:  'Jira location',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :context_path,
+            env_name: 'FL_JIRA_CONTEXT_PATH',
+            description:  'Jira context path',
+            optional: true,
+            default_value: ''
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :disable_ssl_verification,
+            env_name: 'FL_JIRA_DISABLE_SSL_VERIFICATION',
+            description:  'Jira SSL Verification mode',
+            optional: true,
+            default_value: false,
+            type: Boolean
+          )
+        ]
+      end
+
+      def self.author
+        'Harry Singh <hhs4harry@gmail.com>'
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/cerberus/actions/release_notes_action.rb

@@ -0,0 +1,132 @@
+require 'fastlane/action'
+require_relative '../helper/cerberus_helper'
+
+module Fastlane
+  module Actions
+    class ReleaseNotesAction < Action
+      def self.run(params)
+        @jira_helper = Helper::CerberusHelper.jira_helper(
+          host: params[:host],
+          username: params[:username],
+          password: params[:password],
+          context_path: params[:context_path],
+          disable_ssl_verification: params[:disable_ssl_verification]
+        )
+        issues = @jira_helper.get(issues: params[:issues])
+        Actions.lane_context[SharedValues::FL_CHANGELOG] = comment(issues: issues, include_commits: params[:include_commits], url: params[:build_url])
+      end
+
+      #####################################################
+      # @!group Helpers
+      #####################################################
+
+      def self.format(issue:)
+        "[#{issue.key}](#{@jira_helper.url(issue: issue)}) - #{issue.summary}"
+      end
+
+      def self.format_issues(issues:, include_commits:)
+        issues.map { |issue| format(issue: issue) }
+              .concat(include_commits)
+              .map { |change| change.prepend("- ") }
+              .join("\n")
+      end
+
+      def self.comment(issues:, include_commits:, url:)
+        changes = format_issues(issues: issues, include_commits: include_commits)
+        changes = 'No changes included.' if changes.to_s.empty?
+
+        changelog = [
+          '### Changelog',
+          '',
+          changes,
+          '',
+          "Built by [Jenkins](#{url})"
+        ].join("\n")
+
+        UI.important(changelog)
+        return changelog
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.details
+        'Creates a markdown friendly change log from the Jira issues and the Jenkins build url'
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.output
+        String
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :issues,
+            env_name: 'FL_RELEASE_NOTES_ISSUES',
+            description:  'Jira issues',
+            optional: true,
+            default_value: [],
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :include_commits,
+            env_name: 'FL_HOCKEY_COMMENT_INCLUDE_COMMITS',
+            description:  'Additional commits',
+            optional: true,
+            default_value: [],
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_url,
+            env_name: 'FL_RELEASE_NOTES_BUILD_URL',
+            description:  'Link to the ci build',
+            optional: true,
+            default_value: ENV['BUILD_URL']
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :username,
+            env_name: 'FL_JIRA_USERNAME',
+            description:  'Jira user',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :password,
+            env_name: 'FL_JIRA_PASSWORD',
+            description:  'Jira user',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :host,
+            env_name: 'FL_JIRA_HOST',
+            description:  'Jira location',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :context_path,
+            env_name: 'FL_JIRA_CONTEXT_PATH',
+            description:  'Jira context path',
+            optional: true,
+            default_value: ''
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :disable_ssl_verification,
+            env_name: 'FL_JIRA_DISABLE_SSL_VERIFICATION',
+            description:  'Jira SSL Verification mode',
+            optional: true,
+            default_value: false,
+            type: Boolean
+          )
+        ]
+      end
+
+      def self.author
+        'Harry Singh <hhs4harry@gmail.com>'
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/cerberus/helper/cerberus_helper.rb

@@ -0,0 +1,80 @@
+require 'fastlane_core/ui/ui'
+require 'jira-ruby'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class CerberusHelper
+      class JiraClientHelper
+        def self.client(host:, username:, password:, context_path:, disable_ssl_verification:)
+          options = {
+           site: host,
+           context_path: context_path,
+           auth_type: :basic,
+           username: username,
+           password: password,
+           ssl_verify_mode: disable_ssl_verification ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+          }
+
+          JIRA::Client.new(options)
+        end
+      end
+
+      class JiraHelper
+        def initialize(host:, username:, password:, context_path:, disable_ssl_verification:, jira_client_helper: nil)
+          @host = host
+          @context_path = context_path
+
+          jira_client_helper ||= JiraClientHelper.client(
+            host: host,
+            username: username,
+            password: password,
+            context_path: context_path,
+            disable_ssl_verification: disable_ssl_verification
+          )
+          @client = jira_client_helper
+        end
+
+        def get(issues:)
+          return [] if issues.to_a.empty?
+
+          begin
+            @client.Issue.jql("KEY IN (#{issues.join(',')})", fields: [:key, :summary], validate_query: false)
+          rescue => e
+            UI.important('Jira Client: Failed to get issue.')
+            UI.important("Jira Client: Reason - #{e.message}")
+            []
+          end
+        end
+
+        def add_comment(comment:, issues:)
+          return if issues.to_a.empty?
+
+          issues.each do |issue|
+            begin
+              issue.comments.build.save({ 'body' => comment })
+            rescue => e
+              UI.important("Jira Client: Failed to comment on issues - #{issue.key}")
+              UI.important("Jira Client: Reason - #{e.message}")
+            end
+          end
+        end
+
+        def url(issue:)
+          [@host, @context_path, 'browse', issue.key].reject(&:empty?).join('/')
+        end
+      end
+
+      def self.jira_helper(host:, username:, password:, context_path:, disable_ssl_verification:)
+        JiraHelper.new(
+          host: host,
+          username: username,
+          password: password,
+          context_path: context_path,
+          disable_ssl_verification: disable_ssl_verification
+        )
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/cerberus/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Cerberus
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-cerberus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+description: 
+email: hhs4harry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/cerberus.rb
+- lib/fastlane/plugin/cerberus/actions/find_commits_action.rb
+- lib/fastlane/plugin/cerberus/actions/find_tickets_action.rb
+- lib/fastlane/plugin/cerberus/actions/jira_comment_action.rb
+- lib/fastlane/plugin/cerberus/actions/release_notes_action.rb
+- lib/fastlane/plugin/cerberus/helper/cerberus_helper.rb
+- lib/fastlane/plugin/cerberus/version.rb
+homepage: https://github.com/outware/fastlane-plugin-cerberus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Cerberus is a fastlane plugin for extracting Jira issues from commit messages
+  and sharing information on its respective Jenkins job and HockeyApp upload.
+test_files: []