fastlane-plugin-jira_util 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e2dc8a0d0e2b0488a8c543325074db3591b803f47481f042106f8472b9e72ec
-  data.tar.gz: d18e7184d7facd0ad1521f265120aa6c8ef21d04989f940d039058a49a35a522
+  metadata.gz: 01ceb94a8d182889d004872ede3566f529912621ff25de0e4cdcf0a447d209e6
+  data.tar.gz: f18b82b15fc492d88e68b0d12f1bd5013f51a108dc731c3b12a7f61418eed6d0
 SHA512:
-  metadata.gz: 6186af046785dab9d719bf6905dd9f870429704efeb48d09bf43cfcc06dba96b1222fdd95e837a1644fa8fcd8ef5d98559af14def9b7b82aac706f76a32ce7ab
-  data.tar.gz: 13d9ca92ba43aac17b7d167fdd2ef63677bb59e33349d7c89f29f09c0946e89a51c16cc83c8cfe74c88e996fd8129b252909120d4d71a6c44bda281d536c0821
+  metadata.gz: 58de2e7dbd44c2acb7ee31addb9e6952eac4d943e10bcfdcd9565125e17d53abb89bbc9429b1c08788fb9d00e3f0857ef6d035dabea94a8eeb05a4472e37fcd9
+  data.tar.gz: 0ce8fc44dd3e0ac3a733b38f5e18456207e9f886fc2afcbeedcafe79e3acf524aca1e9ba08ac742067d76c8758b2a69423f641dbfd7aa0388af9b070bc1bb26e

data/README.md

@@ -14,12 +14,14 @@ fastlane add_plugin jira_util
 
 Manage your JIRA project's releases/versions with this plugin.
 
-Currently, jira_util comes with following actions actions: `create_jira_issue`, `create_jira_version`, `create_or_update_jira_version` and `release_jira_version`.
+Currently, jira_util comes with following actions actions: `create_jira_issue`, `create_jira_version`, `get_jira_release_report_link`, `get_jira_version`, `release_jira_version` and `update_jira_version`.
 About actions:
 * `create_jira_issue` - will create a new issue in your JIRA project.
 * `create_jira_version` - will create a new version. It fails if version with same name already exists in JIRA project.
-* `create_or_update_jira_version` -  similar to `create_jira_version`, but will update existing version.
+* `get_jira_release_report_link` - returns link to JIRA release report.
+* `get_jira_version` - returns existing JIRA version.
 * `release_jira_version` - release existing version in JIRA project.
+* `update_jira_version` -  updates existing version.
 
 ## Create Version Example
 

data/lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb

@@ -0,0 +1,166 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      JIRA_UTIL_GET_JIRA_RELEASE_REPORT_LINK_RESULT = :JIRA_UTIL_GET_JIRA_RELEASE_REPORT_LINK_RESULT
+    end
+
+    class GetJiraReleaseReportLinkAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        site         = params[:url]
+        context_path = ""
+        auth_type    = :basic
+        username     = params[:username]
+        password     = params[:password]
+        project_name = params[:project_name]
+        project_id   = params[:project_id]
+        released     = true
+
+        options = {
+          username:     username,
+          password:     password,
+          site:         site,
+          context_path: context_path,
+          auth_type:    auth_type,
+          read_timeout: 120
+        }
+
+        client = JIRA::Client.new(options)
+
+        unless project_name.nil?
+          project = client.Project.find(project_name)
+          project_id = project.key
+        end
+        raise ArgumentError.new("Project not found.") if project_id.nil?
+
+        version = nil
+        if !params[:version_id].nil?
+          version = project.versions.find { |version| version.id == params[:version_id] }
+        elsif !params[:version_name].nil?
+          version = project.versions.find { |version| version.name == params[:version_name] }
+        end
+
+        raise ArgumentError.new("Version not found.") if version.nil?
+
+        version_id = version.id
+
+        raise ArgumentError.new("Version has empty id.") if version_id.nil?
+
+        release_report_path = "/projects/#{project.key}/versions/#{version_id}/tab/release-report-all-issues"
+        release_report_link = URI.join(site, release_report_path).to_s
+
+        Actions.lane_context[SharedValues::JIRA_UTIL_GET_JIRA_RELEASE_REPORT_LINK_RESULT] = release_report_link
+        release_report_link
+      rescue RuntimeError
+        UI.user_error!("#{$!}")
+        nil
+      rescue JIRA::HTTPError
+        UI.user_error!("Failed to find JIRA version: #{$!.response.body}")
+        nil
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Return link to JIRA release report."
+      end
+
+      def self.details
+        "Return link to JIRA release report. Link looks like https://JIRA_SITE/projects/PROJ/versions/VERSION/tab/release-report-all-issues"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                      env_name: "FL_JIRA_UTIL_SITE",
+                                      description: "URL for Jira instance",
+                                      type: String,
+                                      verify_block: proc do |value|
+                                        UI.user_error!("No url for Jira given, pass using `url: 'url'`") unless value and !value.empty?
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_UTIL_USERNAME",
+                                       description: "Username for JIRA instance",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username given, pass using `username: 'jira_user'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_UTIL_PASSWORD",
+                                       description: "Password for Jira",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password given, pass using `password: 'T0PS3CR3T'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_name,
+                                       env_name: "FL_JIRA_UTIL_PROJECT_NAME",
+                                       description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:project_id],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'project_name' and '#{project_id}' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "FL_JIRA_UTIL_PROJECT_ID",
+                                       description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:project_name],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'project_id' and '#{project_name}' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :version_id,
+                                       description: "JIRA version id. E.g. 123456",
+                                       optional: true,
+                                       conflicting_options: [ :version_name ],
+                                       conflict_block: proc do |value|
+                                         UI.user_error!("You can't use 'id' and 'name' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Empty verison id") unless !value.nil? and !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :version_name,
+                                       description: "JIRA version name",
+                                       is_string: false,
+                                       optional: true,
+                                       conflicting_options: [:version_id],
+                                       conflict_block: proc do |value|
+                                          UI.user_error!("You can't use 'id' and 'name' options in one run")
+                                       end,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("Empty verison name") unless !value.nil? and !value.empty?
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['JIRA_UTIL_GET_JIRA_RELEASE_REPORT_LINK_RESULT', 'JIRA release report link']
+        ]
+      end
+
+      def self.return_value
+        'JIRA release report link'
+      end
+
+      def self.authors
+        [ "https://github.com/alexeyn-martynov" ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module JiraUtil
-    VERSION = "0.2.1"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-jira_util
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - "%q{Alexey Martynov}"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jira-ruby
@@ -161,6 +161,7 @@ files:
 - lib/fastlane/plugin/jira_util.rb
 - lib/fastlane/plugin/jira_util/actions/create_jira_issue.rb
 - lib/fastlane/plugin/jira_util/actions/create_jira_version.rb
+- lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb
 - lib/fastlane/plugin/jira_util/actions/get_jira_version.rb
 - lib/fastlane/plugin/jira_util/actions/release_jira_version.rb
 - lib/fastlane/plugin/jira_util/actions/update_jira_version.rb
@@ -185,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: "%q{Create JIRA issues and manage versions with this plugin}"