fastlane-plugin-jira_issues_release_notes 0.2.0 → 1.0.0

data/lib/fastlane/plugin/jira_issues_release_notes/actions/{branch_jira_issues_release_notes_action.rb → jira_feature_validation_action.rb}

@@ -3,15 +3,18 @@ require_relative '../helper/jira_issues_release_notes_helper'
 
 module Fastlane
   module Actions
-    class BranchJiraIssuesReleaseNotesAction < Action
+    class JiraFeatureValidationAction < Action
       def self.run(params)
         branch = other_action.git_branch
-        regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+        ticket_key = Helper::JiraIssuesReleaseNotesHelper.extract_key_from_branch(
+          branch: branch,
+          ticket_prefix: params[:ticket_prefix]
+        )
 
         @format = params[:format]
         @extra_fields = params[:extra_fields]
+        @format_line_break = @format === 'html' ? '<br />' : "\n"
 
-        ticket_code = regex.match branch
 
         return ticket_not_found unless ticket_code
 
@@ -20,6 +23,7 @@ module Fastlane
 
         @jira_helper = Helper::JiraIssuesReleaseNotesHelper.jira_helper(
           host: params[:host],
+          api_version: params[:api_version],
           username: params[:username],
           password: params[:password],
           context_path: params[:context_path],
@@ -31,34 +35,6 @@ module Fastlane
         return ticket_not_found ticket_code unless issue
 
         generate_message_with(issue: issue)
-
-      #   tickets = tickets(commits: commits, regex: regex)
-      #   UI.important("Jira tickets: #{tickets}")
-
-      #   @jira_helper = Helper::JiraIssuesReleaseNotesHelper.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: tickets)
-
-      #   to_validate = issues.select { |issue| params[:to_validate_status].include?(issue.status.name) }
-      #   validated = issues.select { |issue| params[:validated_status].include?(issue.status.name) }
-
-      #   generate_changelog(to_validate: to_validate, validated: validated, format: params[:format], url: params[:build_url])
-      # end
-
-      # def self.generate_changelog(to_validate:, validated:, format:, url:)
-      #   changelog = []
-      #   changelog.concat(format_issues(label: 'Tasks to validate', issues: to_validate, format: format)) unless to_validate.empty?
-      #   changelog.concat(['']) unless changelog.to_s.empty?
-      #   changelog.concat(format_issues(label: 'Validated tasks', issues: validated, format: format)) unless validated.empty?
-      #   # changes = format_issues(issues: issues)
-      #   changelog = ['No changes included.'] if changelog.to_s.empty?
-
-      #   changelog.join("\n")
       end
 
       def self.ticket_not_found(ticket_code = "")
@@ -70,48 +46,12 @@ module Fastlane
         header_text = ticket_code ? "😅 Jira issue with key '#{ticket_code}' could not be found" : "😅 Jira issue could not be detected"
 
         return [
-          style_text(text: header_text, style: 'heading'),
-          style_text(text: "► Latest Commit:", style: 'bold'),
+          Helper::JiraIssuesReleaseNotesHelper.style_text(text: header_text, style: 'heading'),
+          Helper::JiraIssuesReleaseNotesHelper.style_text(text: "► Latest Commit:", style: 'bold'),
           last_commit[:message]
         ].join("\n")
       end
-
-      def self.style_text(text:, style:)
-        # formats the text according to the style we're looking to use
-
-        # Skips all styling
-        case style
-        when "title"
-          case @format
-          when "markdown"
-            "# #{text}"
-          when "slack"
-            "*#{text}*"
-          else
-            text
-          end
-        when "heading"
-          case format
-          when "markdown"
-            "### #{text}"
-          when "slack"
-            "*#{text}*"
-          else
-            "#{text}:"
-          end
-        when "bold"
-          case format
-          when "markdown"
-            "**#{text}**"
-          when "slack"
-            "*#{text}*"
-          else
-            text
-          end
-        else
-          text # catchall, shouldn't be needed
-        end
-      end
+      
 
       def self.generate_message_with(issue:)
         link = @jira_helper.url(issue: issue)
@@ -127,7 +67,7 @@ module Fastlane
             extra.flatten!
           ]
           .flatten!
-          .join("\n")
+          .join(@format_line_break)
         when "markdown"
           extra = @extra_fields.map { |key, value| ["", "**► #{key.to_s}**", issue.attrs["fields"][value.to_s]] }
           [
@@ -136,7 +76,16 @@ module Fastlane
             extra.flatten!
           ]
           .flatten!
-          .join("\n")
+          .join(@format_line_break)
+        when "html"
+          extra = @extra_fields.map { |key, value| ["", "<strong>&#9658; #{key.to_s}</strong>", issue.attrs["fields"][value.to_s]] }
+          [
+            "<strong>&#9658; #{issue_type}: <a href=\"#{link}\" target=\"_blank\">#{issue.summary}</a></strong> (#{status})", 
+            issue.description, 
+            extra.flatten!
+          ]
+          .flatten!
+          .join(@format_line_break)
         else
           extra = @extra_fields.map { |key, value| ["", "► #{key.to_s}", issue.attrs["fields"][value.to_s]] }
           [
@@ -145,7 +94,7 @@ module Fastlane
             extra.flatten!
           ]
           .flatten!
-          .join("\n")
+          .join(@format_line_break)
         end
       end
 
@@ -175,20 +124,13 @@ module Fastlane
             default_value: '[A-Z]+',
             optional: true
           ),
-          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: :format,
-            description: "You can use either markdown, slack or plain",
+            description: "You can use either markdown, slack, html or plain",
             default_value: "markdown",
             optional: true,
             verify_block: proc do |value|
-              UI.user_error!("Invalid format! You can use either markdown, slack or plain") unless ['markdown', 'slack', 'plain'].include?(value)
+              UI.user_error!("Invalid format! You can use either markdown, slack, html or plain") unless ['markdown', 'html', 'slack', 'plain'].include?(value)
             end
           ),
           FastlaneCore::ConfigItem.new(
@@ -218,6 +160,13 @@ module Fastlane
             description:  'Jira location',
             optional: false
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :api_version,
+            env_name: 'FL_JIRA_API_VERSION',
+            description:  'Jira api version',
+            default_value: '2',
+            optional: true,
+          ),
           FastlaneCore::ConfigItem.new(
             key: :context_path,
             env_name: 'FL_JIRA_CONTEXT_PATH',

data/lib/fastlane/plugin/jira_issues_release_notes/actions/jira_issues_keys_from_commits_action.rb

@@ -0,0 +1,134 @@
+require 'fastlane/action'
+require_relative '../helper/jira_issues_release_notes_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      FL_JIRA_LAST_TAG ||= :S3_APK_OUTPUT_PATH
+      FL_JIRA_LAST_TAG_HASH ||= :FL_JIRA_LAST_TAG_HASH
+      FL_JIRA_COMMITS_FROM_HASH ||= :FL_JIRA_COMMITS_FROM_HASH
+      FL_JIRA_LAST_KEYS_FROM_COMMITS ||= :FL_JIRA_LAST_KEYS_FROM_COMMITS
+      FL_JIRA_LAST_ISSUES_FROM_COMMITS ||= :FL_JIRA_LAST_ISSUES_FROM_COMMITS
+    end
+
+    class JiraIssuesKeysFromCommitsAction < Action
+      def self.run(params)
+        Helper::JiraIssuesReleaseNotesHelper.initialize_jira(
+          host: params[:host],
+          api_version: params[:api_version],
+          username: params[:username],
+          password: params[:password],
+          context_path: params[:context_path],
+          disable_ssl_verification: params[:disable_ssl_verification]
+        )
+
+        issue_key_regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+
+        Helper::JiraIssuesReleaseNotesHelper.get_keys_from_commit_after_latest_tag(
+          tag_regex: params[:tag_prefix],
+          tag_version_match: params[:tag_version_match],
+          issue_key_regex: issue_key_regex,
+          debug: params[:debug]
+        )
+      end
+
+      def self.description
+        "It generates a release note based on the issues keys found in branch name and descriptions found in the commits"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        ["ABC-123",  "ABC-321"]
+      end
+
+      def self.details
+        # Optional:
+        "It generates a release note based on the issues keys found in branch name and descriptions found in the commits"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :tag_prefix,
+            description: "Match parameter of git describe. See man page of git describe for more info",
+            verify_block: proc do |value|
+              UI.user_error!("No match for analyze_commits action given, pass using `match: 'expr'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :ticket_prefix,
+            env_name: 'FL_FIND_TICKETS_MATCHING',
+            description:  'regex to extract ticket numbers',
+            default_value: '[A-Z]+',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :tag_version_match,
+            description: "To parse version number from tag name",
+            default_value: '\d+\.\d+\.\d+'
+          ),
+
+          # Jira Client options
+          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: :api_version,
+            env_name: 'FL_JIRA_API_VERSION',
+            description:  'Jira api version',
+            default_value: '2',
+            optional: true,
+          ),
+          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
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :debug,
+            description: "True if you want to log out a debug info",
+            default_value: false,
+            type: Boolean,
+            optional: true
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_issues_release_notes/actions/jira_release_changelog_action.rb

@@ -0,0 +1,182 @@
+require 'fastlane/action'
+require_relative '../helper/jira_issues_release_notes_helper'
+
+module Fastlane
+  module Actions
+
+    module SharedValues
+      FL_JIRA_LAST_TAG ||= :S3_APK_OUTPUT_PATH
+      FL_JIRA_LAST_TAG_HASH ||= :FL_JIRA_LAST_TAG_HASH
+      FL_JIRA_COMMITS_FROM_HASH ||= :FL_JIRA_COMMITS_FROM_HASH
+      FL_JIRA_LAST_KEYS_FROM_COMMITS ||= :FL_JIRA_LAST_KEYS_FROM_COMMITS
+      FL_JIRA_LAST_ISSUES_FROM_COMMITS ||= :FL_JIRA_LAST_ISSUES_FROM_COMMITS
+    end
+
+    class JiraReleaseChangelogAction < Action
+      def self.run(params)
+        Helper::JiraIssuesReleaseNotesHelper.initialize_jira(
+          host: params[:host],
+          api_version: params[:api_version],
+          username: params[:username],
+          password: params[:password],
+          context_path: params[:context_path],
+          disable_ssl_verification: params[:disable_ssl_verification]
+        )
+
+        issue_key_regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+
+        issues = Helper::JiraIssuesReleaseNotesHelper.get_issues_from_commit_after_latest_tag(
+          tag_regex: params[:tag_prefix],
+          tag_version_match: params[:tag_version_match],
+          issue_key_regex: issue_key_regex,
+          debug: params[:debug]
+        )
+
+        return '' unless issues
+
+        @format = params[:format]
+        @format_line_break = @format === 'html' ? '<br />' : "\n"
+
+        grouped_by_types = params[:grouped_by_types]
+
+        grouped_issues = {}
+
+        group_key_for_any = nil
+
+        grouped_by_types.each do |key, value|
+          matched_issues = issues.filter {|issue| value.include?(issue.issuetype.name) }
+          not_matched_issues = issues.filter {|issue| !value.include?(issue.issuetype.name) }
+
+          grouped_issues[key] = matched_issues
+
+          issues = not_matched_issues
+
+          group_key_for_any = key if value.include? "ANY_TYPE"
+        end
+        
+        if group_key_for_any and issues then
+          grouped_issues[group_key_for_any].concat issues
+        end
+
+        Helper::JiraIssuesReleaseNotesHelper.generate_changelog(
+          groups: grouped_issues, 
+          line_break_format: @format_line_break
+        )
+      end
+
+      def self.description
+        "It generates a release note based on the issues keys and descriptions found in the commits"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "It generates a release note based on the issues keys and descriptions found in the commits"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :tag_prefix,
+            description: "Match parameter of git describe. See man page of git describe for more info",
+            verify_block: proc do |value|
+              UI.user_error!("No match for analyze_commits action given, pass using `match: 'expr'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :ticket_prefix,
+            env_name: 'FL_FIND_TICKETS_MATCHING',
+            description:  'regex to extract ticket numbers',
+            default_value: '[A-Z]+',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :tag_version_match,
+            description: "To parse version number from tag name",
+            default_value: '\d+\.\d+\.\d+'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :grouped_by_types,
+            env_name: 'FL_JIRA_RELESE_GROUPED_TYPES',
+            description:  'Hash with grouped types with names by issue type. Use de key work "ANY_TYPE" as fallback. Example: { "Fixed" => ["Bug"], "Added/Changed" => ["Story", "Task"], "Others" => ["ANY_TYPE"] } ',
+            optional: false,
+            type: Hash
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :format,
+            description: "You can use either markdown, slack, html or plain",
+            default_value: "markdown",
+            optional: true,
+            verify_block: proc do |value|
+              UI.user_error!("Invalid format! You can use either markdown, slack, html or plain") unless ['markdown', 'html', 'slack', 'plain'].include?(value)
+            end
+          ),
+
+          # Jira Client options
+          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 password',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :host,
+            env_name: 'FL_JIRA_HOST',
+            description:  'Jira location',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :api_version,
+            env_name: 'FL_JIRA_API_VERSION',
+            description:  'Jira api version',
+            default_value: '2',
+            optional: true,
+          ),
+          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
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :debug,
+            description: "True if you want to log out a debug info",
+            default_value: false,
+            type: Boolean,
+            optional: true
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end