fastlane-plugin-jira_release_notes 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a99744e85725346873a9b4f4e88546cfc8a7f8f13105e87872e5266fc1831b9
-  data.tar.gz: 1d4c21bfc23b5f912a754ca033818691e449df9df627ef80a30ef4e27521be72
+  metadata.gz: df95b3762886fed53599c9c7e1496fbe859fd5516af8ebb60d0ef730b465660a
+  data.tar.gz: c880b43871c63e4e64c59bdbae968aa08a86c9434790dddffa49de0d85407e5e
 SHA512:
-  metadata.gz: 90c985aa94a6bbb1770845c7dc3b3a9d323bd647440969d11bb6a69f732b531466d071342f2b7fc5b65875f0ff650a2208b4432709c492ccbcf13543a66920e8
-  data.tar.gz: c39d38cfca7853fae9d92d41d391666512274900790fdaa558d8faf282da8df203ab6a9f27581eaa544f5d3d7d739f4b978762d3248a902d600048b98b7ade67
+  metadata.gz: b4d7d44a35cb79ca4b313a542f5cf99c840f7a544a604d5d1c2626e0074e454651825d2c756837eefda143bb0c0b2e4416e2b05607e0f055646a2283156ee456
+  data.tar.gz: 7f15cfce25c0586ccdbbbf34474566def59edb627c4a3aa6be2fec71ef8a51062c94cbe86fc5a95f60bdee2949a4a4955c0bc39dcdc37903b94c77fc03c462f1

data/README.md

@@ -19,6 +19,41 @@ Release notes from JIRA for version
 
 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`.
 
+```ruby
+lane :notes do
+  text = jira_release_notes(
+    username: "me",
+    password: "123", # password or api token
+    url:      "https://jira.example.com",
+    project:  "OX",
+    version:  "0.1",
+    status:  "Testable",
+    format: "plain"
+  )
+  puts text
+end
+```
+
+## Options
+
+```
+fastlane action jira_release_notes
+```
+
+[How to generate an API Access Token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html)
+
+Key | Description | Env Var | Default
+----|-------------|---------|--------
+url | URL for Jira instance | FL_JIRA_SITE |
+username | Username for Jira instance | FL_JIRA_USERNAME |
+password | Password for Jira or api token | FL_JIRA_PASSWORD |
+project | Jira project name | FL_JIRA_PROJECT |
+version | Jira project version | FL_JIRA_PROJECT_VERSION |
+status | Jira issue status | FL_JIRA_STATUS |
+components | An array of Jira issue components | FL_JIRA_COMPONENTS |
+format | Format text. Plain, html or none | FL_JIRA_RELEASE_NOTES_FORMAT | plain
+max_results | Maximum number of issues | FL_JIRA_RELEASE_NOTES_MAX_RESULTS | 50
+
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/jira_release_notes/actions/jira_release_notes_action.rb

@@ -15,6 +15,9 @@ module Fastlane
 
         version = params[:version]
         project = params[:project]
+        status = params[:status]
+        components = params[:components]
+        max_results = params[:max_results].to_i
         issues = []
 
         UI.message("Fetch issues from JIRA project '#{project}', version '#{version}'")
@@ -24,17 +27,26 @@ module Fastlane
             versions = client.Project.find(project).versions
                              .select { |v| version.match(v.name) }
                              .map { |v| "'#{v.name}'" } .join(', ')
-            issues = client.Issue.jql("PROJECT = '#{project}' AND fixVersion in (#{versions})")
+            jql = "PROJECT = '#{project}' AND fixVersion in (#{versions})"
           else
-            issues = client.Issue.jql("PROJECT = '#{project}' AND fixVersion = '#{version}'")
+            jql = "PROJECT = '#{project}' AND fixVersion = '#{version}'"
           end
+          unless status.nil? or status.empty?
+            jql += " AND status = '#{status}'"
+          end
+          unless components.nil? or components.empty?
+            jql += " AND component in (#{components.map{|s| "\"#{s}\""}.join(", ")})"
+          end
+          UI.message("jql '#{jql}'")
+          issues = client.Issue.jql(jql,max_results: max_results)
+
         rescue JIRA::HTTPError => e
           fields = [e.code, e.message]
           fields << e.response.body if e.response.content_type == "application/json"
           UI.user_error!("#{e} #{fields.join(', ')}")
         end
 
-        UI.success("📝  #{issues.count} issues from JIRA project '#{project}', version '#{version}'")
+        UI.success("📝  #{issues.count} issues from JIRA project '#{project}', version '#{version}', status '#{status}', components '#{components}'")
 
         case params[:format]
         when "plain"
@@ -62,6 +74,10 @@ module Fastlane
         "List of issues from jira. Formatted string or class"
       end
 
+      def self.return_type
+        :string
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :url,
@@ -78,7 +94,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :password,
                                        env_name: "FL_JIRA_PASSWORD",
-                                       description: "Password for Jira",
+                                       description: "Password or api token for Jira",
                                        sensitive: true,
                                        verify_block: proc do |value|
                                          UI.user_error!("No password") if value.to_s.length == 0
@@ -90,6 +106,17 @@ module Fastlane
                                        verify_block: proc do |value|
                                          UI.user_error!("No Jira project name") if value.to_s.length == 0
                                        end),
+          FastlaneCore::ConfigItem.new(key: :status,
+                                       env_name: "FL_JIRA_STATUS",
+                                       description: "Jira issue status",
+                                       sensitive: true,
+                                       default_value: ""),
+          FastlaneCore::ConfigItem.new(key: :components,
+                                       env_name: "FL_JIRA_COMPONENTS",
+                                       description: "Jira issue components",
+                                       type: Array,
+                                       sensitive: true,
+                                       default_value: ""),
           FastlaneCore::ConfigItem.new(key: :version,
                                        env_name: "FL_JIRA_PROJECT_VERSION",
                                        description: "Jira project version",
@@ -103,7 +130,11 @@ module Fastlane
                                        env_name: "FL_JIRA_RELEASE_NOTES_FORMAT",
                                        description: "Format text. Plain, html or none",
                                        sensitive: true,
-                                       default_value: "plain")
+                                       default_value: "plain"),
+          FastlaneCore::ConfigItem.new(key: :max_results,
+                                       env_name: "FL_JIRA_RELEASE_NOTES_MAX_RESULTS",
+                                       description: "Maximum number of issues",
+                                       default_value: "50")
         ]
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module JiraReleaseNotes
-    VERSION = "0.2.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-jira_release_notes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alexander Ignition
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jira-ruby
@@ -153,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Release notes from JIRA for version