fastlane-plugin-jira_release_notes 0.2.0

checksums.yaml

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alexander Ignition <izh.sever@gmail.com>
+
+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,50 @@
+# jira_release_notes plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_release_notes)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_release_notes`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_release_notes
+```
+
+## About jira_release_notes
+
+Release notes from JIRA for version
+
+
+## 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
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+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/jira_release_notes.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/jira_release_notes/version'
+
+module Fastlane
+  module JiraReleaseNotes
+    # 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::JiraReleaseNotes.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,144 @@
+module Fastlane
+  module Actions
+    class JiraReleaseNotesAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        client = JIRA::Client.new(
+          username:     params[:username],
+          password:     params[:password],
+          site:         params[:url],
+          context_path: '',
+          auth_type:    :basic
+        )
+
+        version = params[:version]
+        project = params[:project]
+        issues = []
+
+        UI.message("Fetch issues from JIRA project '#{project}', version '#{version}'")
+
+        begin
+          if version.kind_of?(Regexp)
+            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})")
+          else
+            issues = client.Issue.jql("PROJECT = '#{project}' AND fixVersion = '#{version}'")
+          end
+        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}'")
+
+        case params[:format]
+        when "plain"
+          Helper::JiraReleaseNotesHelper.plain_format(issues)
+        when "html"
+          Helper::JiraReleaseNotesHelper.html_format(issues, params[:url])
+        else
+          issues
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Jira release notes"
+      end
+
+      def self.details
+        "Fetch release notes for Jira project for version"
+      end
+
+      def self.return_value
+        "List of issues from jira. Formatted string or class"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_JIRA_SITE",
+                                       description: "URL for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No url for Jira given") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       description: "Username for Jira instance",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No username") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password for Jira",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No password") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project,
+                                       env_name: "FL_JIRA_PROJECT",
+                                       description: "Jira project name",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Jira project name") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       env_name: "FL_JIRA_PROJECT_VERSION",
+                                       description: "Jira project version",
+                                       sensitive: true,
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("'version' value must be a String or Regexp! Found #{value.class} instead.") unless value.kind_of?(String) || value.kind_of?(Regexp)
+                                         UI.user_error!("No Jira project version") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :format,
+                                       env_name: "FL_JIRA_RELEASE_NOTES_FORMAT",
+                                       description: "Format text. Plain, html or none",
+                                       sensitive: true,
+                                       default_value: "plain")
+        ]
+      end
+
+      def self.authors
+        ["Alexander Ignition"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'notes = jira_release_notes(
+            url: "https://bugs.yourdomain.com",
+            username: "Your username",
+            password: "Your password",
+            project: "ABC",
+            version: "1.0"
+          )
+          gym
+          crashlytics(notes: notes)',
+          'notes = jira_release_notes(
+            project: "ABC",
+            version: "1.0",
+            format: "html"
+          )
+          gym
+          slack(message: notes)'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_release_notes/helper/jira_release_notes_helper.rb

@@ -0,0 +1,20 @@
+module Fastlane
+  module Helper
+    class JiraReleaseNotesHelper
+      # class methods that you define here become available in your action
+      # as `Helper::JiraReleaseNotesHelper.your_method`
+
+      def self.plain_format(issues)
+        issues.map { |i| "[#{i.key}] - #{i.summary}" } .join("\n")
+      end
+
+      def self.html_format(issues, url)
+        require "cgi"
+        issues.map do |i|
+          summary = CGI.escapeHTML(i.summary)
+          "[<a href='#{url}/browse/#{i.key}'>#{i.key}</a>] - #{summary}"
+        end.join("\n")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_release_notes
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexander Ignition
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-04 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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: 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'
+  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.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.49.0
+description: 
+email: izh.sever@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_release_notes.rb
+- lib/fastlane/plugin/jira_release_notes/actions/jira_release_notes_action.rb
+- lib/fastlane/plugin/jira_release_notes/helper/jira_release_notes_helper.rb
+- lib/fastlane/plugin/jira_release_notes/version.rb
+homepage: https://github.com/RedMadRobot/fastlane-plugin-jira_release_notes
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Release notes from JIRA for version
+test_files: []