fastlane-plugin-set_jira_fix_version 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c85148e12d7d864168c8acb743ca0476c6e2f17
+  data.tar.gz: 65b405af05ae939e543f3f6597fca6530dd7e87b
+SHA512:
+  metadata.gz: 2ec94d2f92dc223a62c929ca899e4339bf19e0ab6ac0057dea75aa33bdb1fac09cda57298ba97f88520d80946d4324c3f94e699258eefcfb5bc35bb97124bee6
+  data.tar.gz: 13f8e976bf5ff4bac5ac9a540feee4c52225de72b0b179b0bf4c59c8f9311766cfb6990ad5ff64d3962296a760119122b8d38c25078e178c22d70013b7555d54

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuriy Tolstoguzov <Yuriy.Tolstoguzov@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,52 @@
+# set_jira_fix_version plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-set_jira_fix_version)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-set_jira_fix_version`, add it to your project by running:
+
+```bash
+fastlane add_plugin set_jira_fix_version
+```
+
+## About set_jira_fix_version
+
+Adds fix version to specified JIRA issues. Creates version if needed
+
+This action allows to easily add fix version to specified JIRA issues. It supports basic and cookie authorization. If JIRA account password won't be specified in parameters (recommended) it will ask it at first launch and save in a macOS keychain. If JIRA version with specified name is not created, this action will create it. The action can take issue IDs from lane context (`FL_JIRA_ISSUE_IDS`) and many other JIRA related parameters from environment variables.
+
+## [WIP]: 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`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## 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/set_jira_fix_version.rb

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

data/lib/fastlane/plugin/set_jira_fix_version/actions/jira_issue_keys_from_changelog.rb

@@ -0,0 +1,93 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      FL_JIRA_ISSUE_IDS = :FL_JIRA_ISSUE_IDS
+    end
+
+    class JiraIssueKeysFromChangelogAction < Action
+      def self.run(params)
+        tag = params[:tag]
+        project_key = params[:project_key]
+
+        if tag.start_with?("`") && tag.end_with?("`")
+          tag_command = tag.tr("`", "")
+          tag = `#{tag_command}`
+          tag.strip!
+        end
+        UI.message("Looking for issue keys starting from tag: #{tag}")
+
+        git_log = `git log #{tag}..HEAD --format=%s`
+        issue_key_regex = /#{project_key}-\d+(?!\!)/
+        issue_keys = git_log.scan(issue_key_regex).uniq
+
+        if issue_keys.nil? || issue_keys.empty?
+          UI.error("No issue keys were found!")
+        else
+          UI.message("Issues found: #{issue_keys}")
+        end
+        Actions.lane_context[SharedValues::FL_JIRA_ISSUE_IDS] = issue_keys
+        return issue_keys
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Gets list of JIRA issues kyes from git log starting from specified tag"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :tag,
+                                       env_name: "FL_JIRA_ISSUE_KEYS_FROM_CHANGELOG_TAG_NAME",
+                                       description: "Tag name of shell command in `` to that returns tag name",
+                                       is_string: true,
+                                       default_value: "`git describe --tags --abbrev=0`"),
+          FastlaneCore::ConfigItem.new(key: :project_key,
+                                       env_name: "FL_JIRA_PROJECT_ID",
+                                       description: "Project key that corresponds to JIRA issue id prefixes",
+                                       is_string: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['FL_JIRA_ISSUE_KEYS_FROM_CHANGELOG', 'JIRA issue keys collected from specified tag']
+        ]
+      end
+
+      def self.return_value
+        "Returns array of JIRA issue keys from git log starting from specified tag"
+      end
+
+      def self.authors
+        ["yuriy-tolstoguzov"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'jira_issue_keys_from_changelog(
+            project_key: "IOS",
+            tag: "builds/latest-tag"
+          )',
+          'jira_issue_keys_from_changelog(
+            project_key: "IOS"
+          )'
+        ]
+      end
+
+      def self.sample_return_value
+        ["IOS-1000", "IOS-1001"]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/set_jira_fix_version/actions/set_jira_fix_version_action.rb

@@ -0,0 +1,185 @@
+module Fastlane
+  module Actions
+    class SetJiraFixVersionAction < Action
+      def self.run(params)
+        Actions.verify_gem!('jira-ruby')
+        require 'jira-ruby'
+
+        site         = params[:url]
+        auth_type    = params[:auth_type]
+        use_cookies  = params[:use_cookies]
+        project_id   = params[:project_key]
+        version_name = params[:version_name]
+        issue_ids    = self.issue_ids_from_param(params)
+
+        account_manager = self.account_manager(params)
+        username = account_manager.user
+        password = account_manager.password
+
+        options = {
+          site: site,
+          auth_type: auth_type,
+          use_cookies: use_cookies,
+          username: username,
+          password: password
+        }
+        client = JIRA::Client.new(options)
+
+        self.save_version(client, version_name, project_id, issue_ids)
+      end
+
+      def self.account_manager(params)
+        require 'credentials_manager'
+
+        username = params[:username]
+        password = params[:password]
+
+        # gets password via interactive shell if needed
+        return CredentialsManager::AccountManager.new(
+          user: username,
+          password: password,
+          prefix: "set_jira_fix_version",
+          note: "set_jira_fix_version fastlane action"
+        )
+      end
+
+      def self.issue_ids_from_param(params)
+        issue_ids = params[:issue_ids]
+
+        if issue_ids.nil?
+          issue_ids = Actions.lane_context[SharedValues::FL_JIRA_ISSUE_IDS]
+        end
+
+        if issue_ids.kind_of?(Array) == false || issue_ids.empty?
+          UI.user_error!("No issue ids or keys were supplied or the value is not an array.")
+          return
+        end
+
+        UI.message("Issues: #{issue_ids}")
+        return issue_ids
+      end
+
+      def self.save_version(client, version_name, project_key, issue_ids)
+        # create new version if needed
+        begin
+          project = client.Project.find(project_key)
+        rescue => error
+          UI.error("JIRA API call failed. Check if JIRA is available and correct credentials for user with proper permissions are provided!")
+          UI.user_error!(error.response)
+          return
+        end
+
+        is_version_created = false
+        project.versions.each do |version|
+          if version.name == version_name
+            is_version_created = true
+            break
+          end
+        end
+
+        # if the version does not exist then create this JIRA version
+        if is_version_created == false
+          version = project.versions.build
+          create_version_parameters = { "name" => version_name, "projectId" => project.id }
+          version.save(create_version_parameters)
+          UI.message("#{version_name} version is created.")
+        else
+          UI.message("#{version_name} version already exists and will be used as a fix version.")
+        end
+
+        # update issues with fix version
+        issue_ids.each do |issue_id|
+          begin
+            issue = client.Issue.find(issue_id)
+          rescue
+            UI.error("JIRA issue with #{issue_id} is not found or specified user don't have permissions to see it. It won't be updated!")
+          end
+          add_new_version_parameters = { 'update' => { 'fixVersions' => [{ 'add' => { 'name' => version_name } }] } }
+          issue.save(add_new_version_parameters)
+          UI.message("#{issue_id} is updated with fix version #{version_name}")
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Adds fix version to specified JIRA issues. Creates version if needed"
+      end
+
+      def self.details
+        [
+          "This action allows to easily add fix version to specified JIRA issues. It supports basic and cookie authorization.",
+          "If JIRA account password won't be specified in parameters (recommended) it will ask it at first launch and save in a macOS keychain.",
+          "If JIRA version with specified name is not created, this action will create it. The action can take issue IDs from lane context",
+          "(FL_JIRA_ISSUE_IDS) and many other JIRA related parameters from environment variables."
+        ].join("\n")
+      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, pass using `url: 'url'`") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_JIRA_USERNAME",
+                                       optional: true,
+                                       description: "Username for JIRA"),
+          FastlaneCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_JIRA_PASSWORD",
+                                       description: "Password for JIRA",
+                                       optional: true,
+                                       sensitive: true),
+          FastlaneCore::ConfigItem.new(key: :auth_type,
+                                       description: "Authorization type to use. Currently supported: :basic or :cookie",
+                                       default_value: :basic),
+          FastlaneCore::ConfigItem.new(key: :use_cookies,
+                                       description: "Whether JIRA client should use cookies",
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :issue_ids,
+                                       description: "Issue IDs or keys for JIRA, i.e. [\"IOS-123\", \"IOS-123\"]",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :version_name,
+                                       env_name: "FL_JIRA_VERSION_NAME",
+                                       description: "Version name that will be set as fix version to specified issues.\nIf version does not exist, it will be created",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :project_key,
+                                       env_name: "FL_JIRA_PROJECT_ID",
+                                       description: "Project ID or key where version will be created if needed",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["yuriy-tolstoguzov", "vadimux"]
+      end
+
+      def self.example_code
+        [
+          'set_jira_fix_version(
+            url: "https://jira.yourdomain.com",
+            username: "Your username",
+            issue_ids: ["IOS-1000", "IOS-1001"],
+            version_name: "1.0.0 (123)",
+            project_key: "IOS"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/set_jira_fix_version/helper/set_jira_fix_version_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class SetJiraFixVersionHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SetJiraFixVersionHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the set_jira_fix_version plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module SetJiraFixVersion
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-set_jira_fix_version
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- yuriy-tolstoguzov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-19 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.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+description: 
+email: Yuriy.Tolstoguzov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fastlane/plugin/set_jira_fix_version/actions/jira_issue_keys_from_changelog.rb
+- lib/fastlane/plugin/set_jira_fix_version/actions/set_jira_fix_version_action.rb
+- lib/fastlane/plugin/set_jira_fix_version/helper/set_jira_fix_version_helper.rb
+- lib/fastlane/plugin/set_jira_fix_version/version.rb
+- lib/fastlane/plugin/set_jira_fix_version.rb
+- README.md
+- LICENSE
+homepage: https://github.com/yuriy-tolstoguzov/fastlane-plugin-set_jira_fix_version
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Adds fix version to specified JIRA issues. Creates version if needed
+test_files: []
+has_rdoc: