fastlane-plugin-jira_issues_release_notes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d2ba687d45982c92cee3cb3d66ac7874a194b8c8963f0c316bfa374dd73ea6
-  data.tar.gz: abf29aeeec5877d64d466afb3687d8ecdf6669493971d957c4ad338200d257b8
+  metadata.gz: d8d5984ded8d97d30b8df79c68c103e923911c516829f203fd1d6b475368f783
+  data.tar.gz: b6262045d8f11134a0c1037004115b7c17a19e86f1264c2dc69b63d9173743ce
 SHA512:
-  metadata.gz: ca3984c1624c8b032edd133c9f6ed01249aa490d18e7249cfded4135ade09195e4a4356b984c2371346408aefeabf0b21c61c04bfc6fefe6bca55efa104687a9
-  data.tar.gz: 8a1ecf4d4207423978077008f516930c17f3182d029a675d768f21fdc5ccbe6df5303087d6fce644d178bb8a488b3f835eb1a2e077a5a2d7ebddaac1b09a34b4
+  metadata.gz: e075f8823aad025a3280acab73817ef50161a14003f6dfa76f2a81f9b6ee2dc24664c94fc6345bd7e1d123fe58586f3624a7e8fd1ba44d851ada7f1003f3e7ae
+  data.tar.gz: 6c841d6bda953fabf5d2ff0f75d4f3e372c6e5b891179df98ca12f8246243d0fdef9f66910d1859fa20268a04b3bdfc00bdb59456f5f13c9d1df4259381d6048

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

@@ -0,0 +1,255 @@
+require 'fastlane/action'
+require_relative '../helper/jira_issues_release_notes_helper'
+
+module Fastlane
+  module Actions
+    class BranchJiraIssuesReleaseNotesAction < Action
+      def self.run(params)
+        branch = other_action.git_branch
+        regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+
+        @format = params[:format]
+        @extra_fields = params[:extra_fields]
+
+        ticket_code = regex.match branch
+
+        return ticket_not_found unless ticket_code
+
+        UI.message "Found ticket code: #{ticket_code}"
+        
+
+        @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]
+        )
+
+        issue = @jira_helper.get(issues: [ticket_code], extra_fields: @extra_fields.values).first
+
+        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 = "")
+
+        UI.important "No ticket code could be extracted from git branch name."
+        UI.message "Trying to use latest git commit"
+        last_commit = other_action.last_git_commit
+        return UI.error "There is no commit" unless last_commit
+        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'),
+          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)
+        issue_type = issue.issuetype ? issue.issuetype.name : ''
+        status = issue.status.name
+        issue.attrs["fields"][:customfield_10040.to_s]
+        case @format
+        when "slack"
+          extra = @extra_fields.map { |key, value| ["", "*► #{key.to_s}*", issue.attrs["fields"][value.to_s]] }
+          [
+            "*► #{issue_type}: <#{link}|#{issue.summary}>* (#{status})", 
+            issue.description,
+            extra.flatten!
+          ]
+          .flatten!
+          .join("\n")
+        when "markdown"
+          extra = @extra_fields.map { |key, value| ["", "**► #{key.to_s}**", issue.attrs["fields"][value.to_s]] }
+          [
+            "**► #{issue_type}: [#{issue.summary}](#{link})** (#{status})", 
+            issue.description, 
+            extra.flatten!
+          ]
+          .flatten!
+          .join("\n")
+        else
+          extra = @extra_fields.map { |key, value| ["", "► #{key.to_s}", issue.attrs["fields"][value.to_s]] }
+          [
+            "► #{issue_type}: #{issue.summary}(#{status}) #{link}", 
+            issue.description, 
+            extra.flatten!
+          ]
+          .flatten!
+          .join("\n")
+        end
+      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
+        # 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 found in branch name and descriptions found in the commits"
+      end
+
+      def self.available_options
+        [
+          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: :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",
+            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)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :extra_fields,
+            description: "Extra jira fields",
+            type: Hash,
+            optional: true,
+            default_value: {},
+          ),
+
+          # 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: :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/helper/jira_issues_release_notes_helper.rb

@@ -61,11 +61,14 @@ module Fastlane
           @client = jira_client_helper
         end
 
-        def get(issues:)
+        def get(issues:, extra_fields: [])
           return [] if issues.to_a.empty?
 
+          fields = [:key, :summary, :status, :issuetype, :description]
+          fields.concat extra_fields
+
           begin
-            @client.Issue.jql("KEY IN (#{issues.join(',')})", fields: [:key, :summary, :status], validate_query: false)
+            @client.Issue.jql("KEY IN (#{issues.join(',')})", fields: fields, validate_query: false)
           rescue StandardError => e
             UI.important('Jira Client: Failed to get issue.')
             UI.important("Jira Client: Reason - #{e.message}")

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

@@ -1,5 +1,5 @@
 module Fastlane
   module JiraIssuesReleaseNotes
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-jira_issues_release_notes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Erick Martins
@@ -159,6 +159,7 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/jira_issues_release_notes.rb
+- lib/fastlane/plugin/jira_issues_release_notes/actions/branch_jira_issues_release_notes_action.rb
 - lib/fastlane/plugin/jira_issues_release_notes/actions/jira_issues_release_notes_action.rb
 - lib/fastlane/plugin/jira_issues_release_notes/helper/jira_issues_release_notes_helper.rb
 - lib/fastlane/plugin/jira_issues_release_notes/version.rb