fastlane-plugin-jira_issues_release_notes 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d2ba687d45982c92cee3cb3d66ac7874a194b8c8963f0c316bfa374dd73ea6
-  data.tar.gz: abf29aeeec5877d64d466afb3687d8ecdf6669493971d957c4ad338200d257b8
+  metadata.gz: f58449be91ef1bc4890ad8e1e3cff0048df15f6eabcab019b84f6e1eed4f115c
+  data.tar.gz: 87d076d95e1d5e6e3c4b33457a11cab52abc6b6ad97fb22bdcb9b2ba685d300d
 SHA512:
-  metadata.gz: ca3984c1624c8b032edd133c9f6ed01249aa490d18e7249cfded4135ade09195e4a4356b984c2371346408aefeabf0b21c61c04bfc6fefe6bca55efa104687a9
-  data.tar.gz: 8a1ecf4d4207423978077008f516930c17f3182d029a675d768f21fdc5ccbe6df5303087d6fce644d178bb8a488b3f835eb1a2e077a5a2d7ebddaac1b09a34b4
+  metadata.gz: 59d229f4caf627261ae8f25a760e850ccea0ee32e502459466d10dd23429bd760d8ecfc612e6d76496f31c692d1aa047bf55d3afd9133a2a23b01384b4ce58cc
+  data.tar.gz: 3ac248ade9dbda28ca71c0eaa089598628dc7d516992451194eb71341de0a8ef10f558563a85cd6eeb3e78c78f062b4c8e32df995e2d02181524dd250189d779

data/README.md

@@ -1,7 +1,13 @@
-# jira_issues_release_notes plugin
+# Jira Issues Release Notes - Fastlane 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)
 
+
+
+It generates a release note based on the issues keys and descriptions found in the commits and branch name
+
+
+
 ## 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:
@@ -10,17 +16,121 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 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.
+## Actions
+
+All actions requires some parameters to access Jira API. 
+**These are the arguments the all share:**
+
+| Argument                 | Type      | Description                      | Optional | Default | Env Name                           |
+| ------------------------ | --------- | -------------------------------- | -------- | ------- | ---------------------------------- |
+| username                 | `String`  | The prefix for yours jira issues |          |         | `FL_JIRA_USERNAME`                 |
+| password                 | `String`  | Jira user password               |          |         | `FL_JIRA_PASSWORD`                 |
+| host                     | `String`  | Jira location                    |          |         | `FL_JIRA_HOST`                     |
+| context_path             | `String`  | Jira context path                | ✓        | Empty   | `FL_JIRA_CONTEXT_PATH`             |
+| disable_ssl_verification | `Boolean` | Jira SSL Verification mode       | ✓        | `false` | `FL_JIRA_DISABLE_SSL_VERIFICATION` |
+
+
+
+### branch_jira_issues_release_notes
+
+This action creates a release note based on the issue key extracted from your branch name. For example a branch called `feature/ABC-1234-some-feature` will extract the `ABC-1234` issue key. 
+
+It should be used to generate version to validate you branch's feature before you merge it. 
+
+**Arguments:**
+
+| Argument      | Type                                    | Description                                                  | Optional | Default              | Env Name                   |
+| ------------- | --------------------------------------- | ------------------------------------------------------------ | -------- | -------------------- | -------------------------- |
+| ticket_prefix | `String` or `Regex`                     | The prefix for yours jira issues                             | ✓        | `[A_Z]+`             | `FL_FIND_TICKETS_MATCHING` |
+| extra_fields  | `Hash`                                  | A hash of extra Jira fields to display.<br />It should be a hash with key as the label for the key and value as the symbol representing the jira's key:<br />Example: `{ "My Custom Field" => :customfield_1 }` | ✓        | Empty Hash<br />`{}` |                            |
+| format        | `slack`, `markdown` , `html` or `plain` | Defines the result format                                    | ✓        | `markdown`           |                            |
+
+**Usage example:**
+
+```ruby
+# Branch: feature/ABC-1234-some-feature
+
+platform :android do 
+	lane :develop do 
+    # Build a apk for development environment
+    build_develop
+    link_to_download = upload_to_s3	
+
+    release_notes = branch_jira_issues_release_notes(
+      ticket_prefix: 'ABC',
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+      format: 'slack',
+      extra_fields: {
+        "What should we test?" => :customfield_1
+      }
+    )
+
+    slack(
+      pretext: ":android: A new android build is available for feature validation\n#{release_notes}", 
+      payload: {
+          "Donwload it here" => link_to_download
+      },
+      success: true
+    )
+	end
+end
+```
 
-## 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)
+### jira_issues_release_notes
+
+This action creates a changelog based on the issue keys extracted from your commits since the latest published tag. 
+
+It should be used to generate version to validate in QA stage. 
+
+**Usage example:**
+
+```ruby
+platform :android do 
+	lane :develop do 
+    # Build a apk for staging environment
+    build_staging
+    link_to_download = upload_to_s3	
+
+		release_notes = jira_issues_release_notes(
+      tag_prefix: 'v*',
+      ticket_prefix: 'ABC',
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+      validated_status: ['To Deploy', 'Done'],
+      to_validate_status: ['To Test', 'To QA'],
+      format: 'slack',
+    )
+
+    slack(
+      pretext: ":android: A new android build is available for QA\n#{release_notes}", 
+      payload: {
+          "Donwload it here" => link_to_download
+      },
+      success: true
+    )
+  end
+end
+```
+
+**Arguments:**
+
+| Argument           | Type                                    | Description                                    | Optional | Default           | Env Name                   |
+| ------------------ | --------------------------------------- | ---------------------------------------------- | -------- | ----------------- | -------------------------- |
+| tag_prefix         | `Regex`                                 | Match prefix to find latest tag. Example: `v*` |          |                   |                            |
+| ticket_prefix      | `String` or `Regex`                     | The prefix for yours jira issues               | ✓        | `[A_Z]+`          | `FL_FIND_TICKETS_MATCHING` |
+| tag_version_match  | `String`                                | To parse version number from tag name          | ✓        | `/\d+\.\d+\.\d+/` |                            |
+| validated_status   | `Array`                                 | List of jira issues status already validated   |          |                   | FL_JIRA_VALIDATED_STATUS   |
+| to_validate_status | `Array`                                 | List of jira issues status to be validated     |          |                   | FL_JIRA_TO_VALIDATE_STATUS |
+| format             | `slack`, `markdown` , `html` or `plain` | Defines the result format                      | ✓        | `markdown`        |                            |
+
+
 
 ## Run tests for this plugin
 
@@ -35,18 +145,26 @@ 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/branch_jira_issues_release_notes_action.rb

@@ -0,0 +1,235 @@
+require 'fastlane/action'
+require_relative '../helper/jira_issues_release_notes_helper'
+
+module Fastlane
+  module Actions
+    class BranchJiraIssuesReleaseNotesAction < Action
+      def self.run(params)
+        branch = other_action.git_branch
+        regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+
+        @format = params[:format]
+        @extra_fields = params[:extra_fields]
+        @format_line_break = @format === 'html' ? '<br />' : "\n"
+
+        ticket_code = regex.match branch
+
+        return ticket_not_found unless ticket_code
+
+        UI.message "Found ticket code: #{ticket_code}"
+        
+
+        @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]
+        )
+
+        issue = @jira_helper.get(issues: [ticket_code], extra_fields: @extra_fields.values).first
+
+        return ticket_not_found ticket_code unless issue
+
+        generate_message_with(issue: issue)
+      end
+
+      def self.ticket_not_found(ticket_code = "")
+
+        UI.important "No ticket code could be extracted from git branch name."
+        UI.message "Trying to use latest git commit"
+        last_commit = other_action.last_git_commit
+        return UI.error "There is no commit" unless last_commit
+        header_text = ticket_code ? "😅 Jira issue with key '#{ticket_code}' could not be found" : "😅 Jira issue could not be detected"
+
+        return [
+          style_text(text: header_text, style: 'heading'),
+          style_text(text: "► Latest Commit:", style: 'bold'),
+          last_commit[:message]
+        ].join("\n")
+      end
+      def self.style_text(text:, 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}*"
+          when "html"
+            "<h1>#{text}</h1>"
+          else
+            text
+          end
+        when "heading"
+          case @format
+          when "markdown"
+            "### #{text}"
+          when "slack"
+            "*#{text}*"
+          when "html"
+            "<h3>#{text}</h3>"
+          else
+            "#{text}:"
+          end
+        when "bold"
+          case @format
+          when "markdown"
+            "**#{text}**"
+          when "slack"
+            "*#{text}*"
+          when "html"
+            "<strong>#{text}</strong>"
+          else
+            text
+          end
+        else
+          text # catchall, shouldn't be needed
+        end
+      end
+
+      def self.generate_message_with(issue:)
+        link = @jira_helper.url(issue: issue)
+        issue_type = issue.issuetype ? issue.issuetype.name : ''
+        status = issue.status.name
+        issue.attrs["fields"][:customfield_10040.to_s]
+        case @format
+        when "slack"
+          extra = @extra_fields.map { |key, value| ["", "*► #{key.to_s}*", issue.attrs["fields"][value.to_s]] }
+          [
+            "*► #{issue_type}: <#{link}|#{issue.summary}>* (#{status})", 
+            issue.description,
+            extra.flatten!
+          ]
+          .flatten!
+          .join(@format_line_break)
+        when "markdown"
+          extra = @extra_fields.map { |key, value| ["", "**► #{key.to_s}**", issue.attrs["fields"][value.to_s]] }
+          [
+            "**► #{issue_type}: [#{issue.summary}](#{link})** (#{status})", 
+            issue.description, 
+            extra.flatten!
+          ]
+          .flatten!
+          .join(@format_line_break)
+        when "html"
+          extra = @extra_fields.map { |key, value| ["", "<strong>&#9658; #{key.to_s}</strong>", issue.attrs["fields"][value.to_s]] }
+          [
+            "<strong>&#9658; #{issue_type}: <a href=\"#{link}\" target=\"_blank\">#{issue.summary}</a></strong> (#{status})", 
+            issue.description, 
+            extra.flatten!
+          ]
+          .flatten!
+          .join(@format_line_break)
+        else
+          extra = @extra_fields.map { |key, value| ["", "► #{key.to_s}", issue.attrs["fields"][value.to_s]] }
+          [
+            "► #{issue_type}: #{issue.summary}(#{status}) #{link}", 
+            issue.description, 
+            extra.flatten!
+          ]
+          .flatten!
+          .join(@format_line_break)
+        end
+      end
+
+      def self.description
+        "It generates a release note based on the issues keys found in branch name 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 found in branch name and descriptions found in the commits"
+      end
+
+      def self.available_options
+        [
+          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: :format,
+            description: "You can use either markdown, slack, html or plain",
+            default_value: "markdown",
+            optional: true,
+            verify_block: proc do |value|
+              UI.user_error!("Invalid format! You can use either markdown, slack, html or plain") unless ['markdown', 'html', 'slack', 'plain'].include?(value)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :extra_fields,
+            description: "Extra jira fields",
+            type: Hash,
+            optional: true,
+            default_value: {},
+          ),
+
+          # 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/actions/jira_issues_release_notes_action.rb

@@ -27,6 +27,10 @@ module Fastlane
       end
 
       def self.run(params)
+
+        @format = params[:format]
+        @format_line_break = @format === 'html' ? '<br />' : "\n"
+
         tag = get_last_tag(
           match: params[:tag_prefix],
           debug: params[:debug]
@@ -80,49 +84,55 @@ module Fastlane
         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])
+        generate_changelog(to_validate: to_validate, validated: validated)
       end
 
-      def self.generate_changelog(to_validate:, validated:, format:, url:)
+      def self.generate_changelog(to_validate:, validated:)
         changelog = []
-        changelog.concat(format_issues(label: 'Tasks to validate', issues: to_validate, format: format)) unless to_validate.empty?
+        changelog.concat(format_issues(label: 'Tasks to validate', issues: to_validate)) 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?
+        changelog.concat(format_issues(label: 'Validated tasks', issues: validated)) unless validated.empty?
         # changes = format_issues(issues: issues)
         changelog = ['No changes included.'] if changelog.to_s.empty?
 
-        changelog.join("\n")
+        changelog.join(@format_line_break)
       end
 
-      def self.style_text(text:, format:, style:)
+      def self.style_text(text:, style:)
         # formats the text according to the style we're looking to use
 
         # Skips all styling
         case style
         when "title"
-          case format
+          case @format
           when "markdown"
             "# #{text}"
           when "slack"
             "*#{text}*"
+          when "html"
+            "<h1>#{text}</h1>"
           else
             text
           end
         when "heading"
-          case format
+          case @format
           when "markdown"
             "### #{text}"
           when "slack"
             "*#{text}*"
+          when "html"
+            "<h3>#{text}</h3>"
           else
             "#{text}:"
           end
         when "bold"
-          case format
+          case @format
           when "markdown"
             "**#{text}**"
           when "slack"
             "*#{text}*"
+          when "html"
+            "<strong>#{text}</strong>"
           else
             text
           end
@@ -131,23 +141,25 @@ module Fastlane
         end
       end
 
-      def self.format_issue_link(issue:, format:)
+      def self.format_issue_link(issue:)
         # formats the link according to the output format we need
-
-        case format
+        link = @jira_helper.url(issue: issue)
+        case @format
         when "slack"
-          "*<#{@jira_helper.url(issue: issue)}|#{issue.key}>*: #{issue.summary}"
+          "*<#{link}|#{issue.key}>*: #{issue.summary}"
         when "markdown"
-          "- **[#{issue.key}](#{@jira_helper.url(issue: issue)})**: #{issue.summary}"
+          "- **[#{issue.key}](#{link})**: #{issue.summary}"
+        when "html"
+          "&nbsp;&nbsp;- <strong><a href=\"#{link}\" target=\"_blank\">#{issue.key}</a><strong>: #{issue.summary}"
         else
-          "- #{issue.key}: #{issue.summary} (#{@jira_helper.url(issue: issue)})"
+          "- #{issue.key}: #{issue.summary} (#{link})"
         end
       end
 
-      def self.format_issues(label:, issues:, format:)
+      def self.format_issues(label:, issues:)
         [
-          style_text(text: "► #{label}", style: 'heading', format: format),
-          issues.map { |issue| format_issue_link(issue: issue, format: format) }
+          style_text(text: "► #{label}", style: 'heading'),
+          issues.map { |issue| format_issue_link(issue: issue) }
         ].flatten!
       end
 
@@ -197,13 +209,6 @@ module Fastlane
             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',
@@ -220,11 +225,11 @@ module Fastlane
           ),
           FastlaneCore::ConfigItem.new(
             key: :format,
-            description: "You can use either markdown, slack or plain",
+            description: "You can use either markdown, slack, html 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)
+              UI.user_error!("Invalid format! You can use either markdown, slack, html or plain") unless ['markdown', 'html', 'slack', 'plain'].include?(value)
             end
           ),
 
@@ -238,7 +243,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(
             key: :password,
             env_name: 'FL_JIRA_PASSWORD',
-            description:  'Jira user',
+            description:  'Jira user password',
             optional: false
           ),
           FastlaneCore::ConfigItem.new(

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

@@ -61,11 +61,14 @@ module Fastlane
           @client = jira_client_helper
         end
 
-        def get(issues:)
+        def get(issues:, extra_fields: [])
           return [] if issues.to_a.empty?
 
+          fields = [:key, :summary, :status, :issuetype, :description]
+          fields.concat extra_fields
+
           begin
-            @client.Issue.jql("KEY IN (#{issues.join(',')})", fields: [:key, :summary, :status], validate_query: false)
+            @client.Issue.jql("KEY IN (#{issues.join(',')})", fields: fields, validate_query: false)
           rescue StandardError => e
             UI.important('Jira Client: Failed to get issue.')
             UI.important("Jira Client: Reason - #{e.message}")

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-jira_issues_release_notes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Erick Martins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jira-ruby
@@ -159,6 +159,7 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/jira_issues_release_notes.rb
+- lib/fastlane/plugin/jira_issues_release_notes/actions/branch_jira_issues_release_notes_action.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