fastlane-plugin-jira_issues_release_notes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8d2ba687d45982c92cee3cb3d66ac7874a194b8c8963f0c316bfa374dd73ea6
+  data.tar.gz: abf29aeeec5877d64d466afb3687d8ecdf6669493971d957c4ad338200d257b8
+SHA512:
+  metadata.gz: ca3984c1624c8b032edd133c9f6ed01249aa490d18e7249cfded4135ade09195e4a4356b984c2371346408aefeabf0b21c61c04bfc6fefe6bca55efa104687a9
+  data.tar.gz: 8a1ecf4d4207423978077008f516930c17f3182d029a675d768f21fdc5ccbe6df5303087d6fce644d178bb8a488b3f835eb1a2e077a5a2d7ebddaac1b09a34b4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Erick Martins <ericknmp@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 @@
+# jira_issues_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_issues_release_notes)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_issues_release_notes`, add it to your project by running:
+
+```bash
+fastlane add_plugin jira_issues_release_notes
+```
+
+## About jira_issues_release_notes
+
+It generates a release note based on the issues keys and descriptions found in the commits
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## 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/jira_issues_release_notes/actions/jira_issues_release_notes_action.rb

@@ -0,0 +1,284 @@
+require 'fastlane/action'
+require_relative '../helper/jira_issues_release_notes_helper'
+
+module Fastlane
+  module Actions
+    class JiraIssuesReleaseNotesAction < Action
+      def self.get_last_tag(params)
+        # Try to find the tag
+        command = "git describe --tags --match=#{params[:match]}"
+        Actions.sh(command, log: params[:debug])
+      rescue StandardError
+        UI.message("Tag was not found for match pattern - #{params[:match]}")
+        ''
+      end
+
+      def self.get_last_tag_hash(params)
+        command = "git rev-list -n 1 refs/tags/#{params[:tag_name]}"
+        Actions.sh(command, log: params[:debug]).chomp
+      end
+
+      def self.get_commits_from_hash(params)
+        Helper::JiraIssuesReleaseNotesHelper.git_log(
+          pretty: '%s|%b|>',
+          start: params[:hash],
+          debug: params[:debug]
+        )
+      end
+
+      def self.run(params)
+        tag = get_last_tag(
+          match: params[:tag_prefix],
+          debug: params[:debug]
+        )
+
+        if tag.empty?
+          UI.message("First commit of the branch is taken as a begining of next release")
+          # If there is no tag found we taking the first commit of current branch
+          hash = Actions.sh('git rev-list --max-parents=0 HEAD', log: params[:debug]).chomp
+        else
+          # Tag's format is v2.3.4-5-g7685948
+          # Get a hash of last version tag
+          tag_name = tag.split('-')[0...-2].join('-').strip
+          parsed_version = tag_name.match(params[:tag_version_match])
+
+          if parsed_version.nil?
+            UI.user_error!("Error while parsing version from tag #{tag_name} by using tag_version_match - #{params[:tag_version_match]}. Please check if the tag contains version as you expect and if you are using single brackets for tag_version_match parameter.")
+          end
+
+          version = parsed_version[0]
+
+          # Get a hash of last version tag
+          hash = get_last_tag_hash(
+            tag_name: tag_name,
+            debug: params[:debug]
+          )
+
+          UI.message("Found a tag #{tag_name} associated with version #{version}")
+        end
+
+        # Get commits log between last version and head
+        commits = get_commits_from_hash(
+          hash: hash,
+          debug: params[:debug]
+        )
+
+        regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+
+        tickets = tickets(commits: commits, regex: regex)
+        UI.important("Jira tickets: #{tickets}")
+
+        @jira_helper = Helper::JiraIssuesReleaseNotesHelper.jira_helper(
+          host: params[:host],
+          username: params[:username],
+          password: params[:password],
+          context_path: params[:context_path],
+          disable_ssl_verification: params[:disable_ssl_verification]
+        )
+        issues = @jira_helper.get(issues: tickets)
+
+        to_validate = issues.select { |issue| params[:to_validate_status].include?(issue.status.name) }
+        validated = issues.select { |issue| params[:validated_status].include?(issue.status.name) }
+
+        generate_changelog(to_validate: to_validate, validated: validated, format: params[:format], url: params[:build_url])
+      end
+
+      def self.generate_changelog(to_validate:, validated:, format:, url:)
+        changelog = []
+        changelog.concat(format_issues(label: 'Tasks to validate', issues: to_validate, format: format)) unless to_validate.empty?
+        changelog.concat(['']) unless changelog.to_s.empty?
+        changelog.concat(format_issues(label: 'Validated tasks', issues: validated, format: format)) unless validated.empty?
+        # changes = format_issues(issues: issues)
+        changelog = ['No changes included.'] if changelog.to_s.empty?
+
+        changelog.join("\n")
+      end
+
+      def self.style_text(text:, format:, style:)
+        # formats the text according to the style we're looking to use
+
+        # Skips all styling
+        case style
+        when "title"
+          case format
+          when "markdown"
+            "# #{text}"
+          when "slack"
+            "*#{text}*"
+          else
+            text
+          end
+        when "heading"
+          case format
+          when "markdown"
+            "### #{text}"
+          when "slack"
+            "*#{text}*"
+          else
+            "#{text}:"
+          end
+        when "bold"
+          case format
+          when "markdown"
+            "**#{text}**"
+          when "slack"
+            "*#{text}*"
+          else
+            text
+          end
+        else
+          text # catchall, shouldn't be needed
+        end
+      end
+
+      def self.format_issue_link(issue:, format:)
+        # formats the link according to the output format we need
+
+        case format
+        when "slack"
+          "*<#{@jira_helper.url(issue: issue)}|#{issue.key}>*: #{issue.summary}"
+        when "markdown"
+          "- **[#{issue.key}](#{@jira_helper.url(issue: issue)})**: #{issue.summary}"
+        else
+          "- #{issue.key}: #{issue.summary} (#{@jira_helper.url(issue: issue)})"
+        end
+      end
+
+      def self.format_issues(label:, issues:, format:)
+        [
+          style_text(text: "► #{label}", style: 'heading', format: format),
+          issues.map { |issue| format_issue_link(issue: issue, format: format) }
+        ].flatten!
+      end
+
+      def self.tickets(commits:, regex:)
+        commits
+          .to_enum(:scan, regex)
+          .map { $& }
+          .reject(&:empty?)
+          .uniq
+      end
+
+      def self.description
+        "It generates a release note based on the issues keys and descriptions found in the commits"
+      end
+
+      def self.authors
+        ["Erick Martins"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "It generates a release note based on the issues keys and descriptions found in the commits"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :tag_prefix,
+            description: "Match parameter of git describe. See man page of git describe for more info",
+            verify_block: proc do |value|
+              UI.user_error!("No match for analyze_commits action given, pass using `match: 'expr'`") unless value && !value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :ticket_prefix,
+            env_name: 'FL_FIND_TICKETS_MATCHING',
+            description:  'regex to extract ticket numbers',
+            default_value: '[A-Z]+',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :tag_version_match,
+            description: "To parse version number from tag name",
+            default_value: '\d+\.\d+\.\d+'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_url,
+            env_name: 'FL_RELEASE_NOTES_BUILD_URL',
+            description:  'Link to the ci build',
+            optional: true,
+            default_value: ENV['BUILD_URL']
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :validated_status,
+            env_name: 'FL_JIRA_VALIDATED_STATUS',
+            description:  'List of jira issues status already validated',
+            optional: false,
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :to_validate_status,
+            env_name: 'FL_JIRA_TO_VALIDATE_STATUS',
+            description:  'List of jira issues status to be validated',
+            optional: false,
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :format,
+            description: "You can use either markdown, slack or plain",
+            default_value: "markdown",
+            optional: true,
+            verify_block: proc do |value|
+              UI.user_error!("Invalid format! You can use either markdown, slack or plain") unless ['markdown', 'slack', 'plain'].include?(value)
+            end
+          ),
+
+          # Jira Client options
+          FastlaneCore::ConfigItem.new(
+            key: :username,
+            env_name: 'FL_JIRA_USERNAME',
+            description:  'Jira user',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :password,
+            env_name: 'FL_JIRA_PASSWORD',
+            description:  'Jira user',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :host,
+            env_name: 'FL_JIRA_HOST',
+            description:  'Jira location',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :context_path,
+            env_name: 'FL_JIRA_CONTEXT_PATH',
+            description:  'Jira context path',
+            optional: true,
+            default_value: ''
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :disable_ssl_verification,
+            env_name: 'FL_JIRA_DISABLE_SSL_VERIFICATION',
+            description:  'Jira SSL Verification mode',
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :debug,
+            description: "True if you want to log out a debug info",
+            default_value: false,
+            type: Boolean,
+            optional: true
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/jira_issues_release_notes/helper/jira_issues_release_notes_helper.rb

@@ -0,0 +1,93 @@
+require 'fastlane_core/ui/ui'
+require 'jira-ruby'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class JiraIssuesReleaseNotesHelper
+      # class methods that you define here become available in your action
+      # as `Helper::JiraIssuesReleaseNotesHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the jira_issues_release_notes plugin helper!")
+      end
+
+      # class methods that you define here become available in your action
+      # as `Helper::SemanticConventionReleaseHelper.your_method`
+      #
+      def self.git_log(params)
+        command = "git log --pretty='#{params[:pretty]}' --reverse #{params[:start]}..HEAD"
+        Actions.sh(command, log: params[:debug]).chomp
+      end
+
+      def self.jira_helper(host:, username:, password:, context_path:, disable_ssl_verification:)
+        JiraHelper.new(
+          host: host,
+          username: username,
+          password: password,
+          context_path: context_path,
+          disable_ssl_verification: disable_ssl_verification
+        )
+      end
+
+      class JiraClientHelper
+        def self.client(host:, username:, password:, context_path:, disable_ssl_verification:)
+          options = {
+           site: host,
+           context_path: context_path,
+           auth_type: :basic,
+           username: username,
+           password: password,
+           ssl_verify_mode: disable_ssl_verification ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+          }
+
+          JIRA::Client.new(options)
+        end
+      end
+
+      class JiraHelper
+        def initialize(host:, username:, password:, context_path:, disable_ssl_verification:, jira_client_helper: nil)
+          @host = host
+          @context_path = context_path
+
+          jira_client_helper ||= JiraClientHelper.client(
+            host: host,
+            username: username,
+            password: password,
+            context_path: context_path,
+            disable_ssl_verification: disable_ssl_verification
+          )
+          @client = jira_client_helper
+        end
+
+        def get(issues:)
+          return [] if issues.to_a.empty?
+
+          begin
+            @client.Issue.jql("KEY IN (#{issues.join(',')})", fields: [:key, :summary, :status], validate_query: false)
+          rescue StandardError => e
+            UI.important('Jira Client: Failed to get issue.')
+            UI.important("Jira Client: Reason - #{e.message}")
+            []
+          end
+        end
+
+        def add_comment(comment:, issues:)
+          return if issues.to_a.empty?
+
+          issues.each do |issue|
+            issue.comments.build.save({ 'body' => comment })
+          rescue StandardError => e
+            UI.important("Jira Client: Failed to comment on issues - #{issue.key}")
+            UI.important("Jira Client: Reason - #{e.message}")
+          end
+        end
+
+        def url(issue:)
+          [@host, @context_path, 'browse', issue.key].reject(&:empty?).join('/')
+        end
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/jira_issues_release_notes.rb

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

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-jira_issues_release_notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erick Martins
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-24 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.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: 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: 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: rspec_junit_formatter
+  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.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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'
+description:
+email: ericknmp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/jira_issues_release_notes.rb
+- lib/fastlane/plugin/jira_issues_release_notes/actions/jira_issues_release_notes_action.rb
+- lib/fastlane/plugin/jira_issues_release_notes/helper/jira_issues_release_notes_helper.rb
+- lib/fastlane/plugin/jira_issues_release_notes/version.rb
+homepage: https://github.com/erick-martins/fastlane-plugin-jira_issues_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: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.4
+signing_key:
+specification_version: 4
+summary: It generates a release note based on the issues keys and descriptions found
+  in the commits
+test_files: []