fastlane-plugin-jira_build_number 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf54a0b5df5f6bf291c85d8c63c3bff81970efc6395fbb9514ab86704aded314
+  data.tar.gz: d39cc6fca41270e2b87e5ce10f6b3c74bfb238fe3d64349708010b0895fe5c71
+SHA512:
+  metadata.gz: 49b5eb17ecf81e04cdbb537116a2018ed9b10f68da705d965222b22b9dde78dbb69b8b07ae672111a5b672feb607cc5f825a59b744d6a3162765991149b3a423
+  data.tar.gz: 8285cc079090b4778b340d67f54ec0a2a91847776f15a65e487e03f0b85d079840dee5e5c4ab26a6e08b185aa798c618b739c7787854cfed883a013679f704eb

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tom Elrod <tom.elrod@goziohealth.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,79 @@
+# jira\_build\_number plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_build_number)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_build_number`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_build_number
+```
+
+## About jira\_build\_number
+
+Insert build number into related jira issues based on commit message or branch containing a jira issue id.  This plugin is intended to be triggered by CI service such as CircleCI or bitrise upon pushing code to a repository.
+
+This plugin requires the following parameters be set or generated and passed to the plugin:
+* commit_message - the last commit message
+* commit_branch - the branch on which the commit occurred
+* version_code - the build number for the code being compiled (e.g. 238)
+* version_name - the version number for the code being compiled (e.g. 1.0.1)
+* jira_hostname - the URL of the jira instance you are using
+* jira_username - the jira username to use to access jira
+* jira_password - the jira password to use to access jira
+
+If the plugin can find a jira issue id in either the commit message or the branch name, it will insert a comment into the jira issue with the provided build number.
+
+## Example
+
+The following is an example of a lane within Fastline file.
+
+```
+  desc "Execute jira build number plugin"
+  lane :jira_build_number do
+    commit = last_git_commit
+    commit_message = commit[:message]
+    commit_branch = git_branch
+    version_code = %x(git rev-list --count HEAD)
+    version_name = get_version_name(
+        gradle_file_path:"app/build.gradle"
+     )
+     puts "Build number: " + version_code
+     puts "Version name: " + version_name
+     jira_hostname = ENV["JIRA_HOSTNAME"]
+     jira_username = ENV["JIRA_USERNAME"]
+     jira_password = ENV["JIRA_PASSWORD"]
+    jira_build_number(commit_message: commit_message, commit_branch: commit_branch, build_number: version_code, version_name: version_name, jira_hostname: jira_hostname, jira_username: jira_username, jira_password: jira_password)
+  end
+
+```
+
+## 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_build_number.rb

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

data/lib/fastlane/plugin/jira_build_number/actions/jira_build_number_action.rb

@@ -0,0 +1,161 @@
+require 'fastlane/action'
+require_relative '../helper/jira_build_number_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      JIRA_ISSUE_ID_VALUE = :JIRA_ISSUE_ID_VALUE
+    end
+
+    class JiraBuildNumberAction < Action
+      def self.run(params)
+        UI.message("Running jira build number action...")
+
+        UI.message "Commit message: #{params[:commit_message]}"
+        UI.message "Commit branch: #{params[:commit_branch]}"
+
+        commitMessage = params[:commit_message]
+        commitBranch = params[:commit_branch]
+
+        # jiraTicketId = commitMessage.match((?<!([A-Za-z]{1,10})-?)[A-Z]+-\d+))
+        jiraTicketId = searchForJiraTicketId(commitMessage)
+
+        #UI.message "Jira ticket id: #{jiraTicketId}"
+
+        if(jiraTicketId.nil?)
+          jiraTicketId = searchForJiraTicketId(commitBranch)
+        end
+
+        UI.message "Jira ticket id: #{jiraTicketId}"
+
+        buildNumber = params[:build_number]
+        buildVersion = params[:version_name]
+
+        UI.message "Build version: #{buildVersion}"
+        UI.message "Build number: #{buildNumber}"
+
+        jiraHostname = params[:jira_hostname]
+        #jiraBasicToken = params[:jira_token]
+        jiraUsername = params[:jira_username]
+        jiraPassword = params[:jira_password]
+
+        jiraBasicToken = Base64.encode64("#{jiraUsername}:#{jiraPassword}")
+
+        if(!jiraTicketId.nil?)
+          response = RestClient.post "https://#{jiraHostname}/rest/api/2/issue/#{jiraTicketId}/comment",
+                                     "{\"body\": \"Build: #{buildVersion}.#{buildNumber}\"}",
+                                     {content_type: "application/json", Authorization: "Basic #{jiraBasicToken}"}
+        end
+
+
+        #UI.message "Jira post response: #{response}"
+
+        # sh "shellcommand ./path"
+
+        # Actions.lane_context[SharedValues::JIRA_BUILD_NUMBER_CUSTOM_VALUE] = "my_val"
+      end
+
+      def self.searchForJiraTicketId(str)
+        /[A-Z]+[-](\d+)/.match(str)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Adds build number from CI as comment to associated jira issue."
+      end
+
+      def self.details
+        # Optional:
+        # this is your chance to provide a more detailed description of this action
+        "Looks for the jira issue id in the branch or commit message and will insert the build number as a comment into that jira issue if found."
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+
+        # Below a few examples
+        [
+            FastlaneCore::ConfigItem.new(key: :jira_username,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_JIRA_USERNAME", # The name of the environment variable
+                                         description: "Jira username for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No jira username for JiraBuildNumberAction given, pass using `build_number: 'build'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :jira_password,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_JIRA_PASSWORD", # The name of the environment variable
+                                         description: "Jira password for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No jira password for JiraBuildNumberAction given, pass using `build_number: 'build'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :jira_hostname,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_JIRA_HOSTNAME", # The name of the environment variable
+                                         description: "Jira hostname for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No jira hostname for JiraBuildNumberAction given, pass using `build_number: 'build'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :jira_token,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_JIRA_TOKEN", # The name of the environment variable
+                                         description: "Jira token for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No jira basic token for JiraBuildNumberAction given, pass using `build_number: 'build'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :build_number,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_BUILD_NUMBER", # The name of the environment variable
+                                         description: "Build number for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No build number for JiraBuildNumberAction given, pass using `build_number: 'build'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :version_name,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_VERSION_NAME", # The name of the environment variable
+                                         description: "Build version for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No build version for JiraBuildNumberAction given, pass using `version_name: 'version'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :commit_branch,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_COMMIT_BRANCH", # The name of the environment variable
+                                         description: "Commit branch for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No commit branch for JiraBuildNumberAction given, pass using `commit_branch: 'branch'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end),
+            FastlaneCore::ConfigItem.new(key: :commit_message,
+                                         env_name: "FL_JIRA_BUILD_NUMBER_COMMIT_MESSAGE", # The name of the environment variable
+                                         description: "Commit message for JiraBuildNumberAction", # a short description of this parameter
+                                         verify_block: proc do |value|
+                                           UI.user_error!("No commit message for JiraBuildNumberAction given, pass using `commit_message: 'message'`") unless (value and not value.empty?)
+                                           # UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                         end)
+        ]
+      end
+
+      def self.output
+        [
+            ['JIRA_ISSUE_ID_VALUE', 'The jira issue id if found within comment or branch name']
+        ]
+      end
+
+      def self.return_value
+        "Returns jira issue id if found within comment or branch"
+      end
+
+      def self.authors
+        ["https://github.com/telrod"]
+      end
+
+      def self.is_supported?(platform)
+        #  true
+        [:ios, :android].include?(platform)
+
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_build_number/helper/jira_build_number_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class JiraBuildNumberHelper
+      # class methods that you define here become available in your action
+      # as `Helper::JiraBuildNumberHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the jira_build_number plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module JiraBuildNumber
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_build_number
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Elrod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: tom.elrod@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_build_number.rb
+- lib/fastlane/plugin/jira_build_number/actions/jira_build_number_action.rb
+- lib/fastlane/plugin/jira_build_number/helper/jira_build_number_helper.rb
+- lib/fastlane/plugin/jira_build_number/version.rb
+homepage: https://github.com/telrod/fastlane-plugin-jira_build_number
+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: Insert build number into related jira issues
+test_files: []