fastlane-plugin-jira_issues_release_notes 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f58449be91ef1bc4890ad8e1e3cff0048df15f6eabcab019b84f6e1eed4f115c
-  data.tar.gz: 87d076d95e1d5e6e3c4b33457a11cab52abc6b6ad97fb22bdcb9b2ba685d300d
+  metadata.gz: e894feb0ef80530060a48ac405ffb1499763677ec0e0b081f56217e8ebad2a74
+  data.tar.gz: e26ecc23aafb34452ba96986225502134354dd678628da1080907790e1f3fcfa
 SHA512:
-  metadata.gz: 59d229f4caf627261ae8f25a760e850ccea0ee32e502459466d10dd23429bd760d8ecfc612e6d76496f31c692d1aa047bf55d3afd9133a2a23b01384b4ce58cc
-  data.tar.gz: 3ac248ade9dbda28ca71c0eaa089598628dc7d516992451194eb71341de0a8ef10f558563a85cd6eeb3e78c78f062b4c8e32df995e2d02181524dd250189d779
+  metadata.gz: 79dbc0a2f9fc8f60c9ce93735673deada3c1add7c1afff3838ebf2bd8821885343360af7ce13d2a4e21baac09f697f67f7a90da02d73c3fca06816cf4236568c
+  data.tar.gz: 903103b90403f032883a08a81d733b990ab70b24108e7e1ed34b6bc54b122f4b3791e15cc9533b8a4fd44138e35fc9e2c86c6e4a7d651c75f8fbe355158ec21d

data/README.md

@@ -1,6 +1,8 @@
 # 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)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/erick-martins/fastlane-plugin-jira_issues_release_notes/blob/master/LICENSE)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-jira_issues_release_notes.svg)](https://badge.fury.io/rb/fastlane-plugin-jira_issues_release_notes)
 
 
 
@@ -30,10 +32,43 @@ All actions requires some parameters to access Jira API.
 | 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` |
+| api_version              | `String`  | Jira api version                 | ✓        | 2       | `FL_JIRA_API_VERSION`              |
 
 
 
-### branch_jira_issues_release_notes
+### jira_issues_keys_from_commits
+
+This action returns the list of jira issue keys extracted from your commits since the latest published tag.  
+
+**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+/` |                            |
+
+**Usage example:**
+
+```ruby
+platform :android do 
+  lane :develop do 
+    keys = jira_issues_keys_from_commits(
+      tag_prefix: 'v*',
+      ticket_prefix: 'ABC',
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+    )
+    
+    puts keys
+	end
+end
+```
+
+
+
+### jira_feature_validation
 
 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. 
 
@@ -53,12 +88,12 @@ It should be used to generate version to validate you branch's feature before yo
 # Branch: feature/ABC-1234-some-feature
 
 platform :android do 
-	lane :develop 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(
+    release_notes = jira_feature_validation(
       ticket_prefix: 'ABC',
       username: ENV["FL_JIRA_USERNAME"],
       password: ENV["FL_JIRA_PASSWORD"],
@@ -72,7 +107,7 @@ platform :android do
     slack(
       pretext: ":android: A new android build is available for feature validation\n#{release_notes}", 
       payload: {
-          "Donwload it here" => link_to_download
+          "Download it here" => link_to_download
       },
       success: true
     )
@@ -82,7 +117,7 @@ end
 
 
 
-### jira_issues_release_notes
+### jira_release_validation
 
 This action creates a changelog based on the issue keys extracted from your commits since the latest published tag. 
 
@@ -92,12 +127,12 @@ It should be used to generate version to validate in QA stage.
 
 ```ruby
 platform :android do 
-	lane :develop do 
+  lane :staging_validation do 
     # Build a apk for staging environment
     build_staging
     link_to_download = upload_to_s3	
 
-		release_notes = jira_issues_release_notes(
+		release_notes = jira_release_validation(
       tag_prefix: 'v*',
       ticket_prefix: 'ABC',
       username: ENV["FL_JIRA_USERNAME"],
@@ -111,7 +146,7 @@ platform :android do
     slack(
       pretext: ":android: A new android build is available for QA\n#{release_notes}", 
       payload: {
-          "Donwload it here" => link_to_download
+          "Download it here" => link_to_download
       },
       success: true
     )
@@ -121,14 +156,217 @@ 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`        |                            |
+| 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`        |                              |
+
+
+
+### jira_release_changelog
+
+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 from a release version. 
+
+**Usage example:**
+
+```ruby
+platform :android do 
+  lane :release do 
+    # Build and release a new version
+    build_production
+    release_production
+		
+    # Hash with grouped types with names by issue type. Use de key work "ANY_TYPE" as fallback.
+		# The ordenation will reflect to the final result.
+    grouped_by_types = { 
+      "Added/Changed" => ["ANY_TYPE"],
+      "Fixed" => ["Bug"]
+    }	
+
+		release_notes = jira_release_changelog(
+      tag_prefix: 'v*',
+      ticket_prefix: 'ABC',
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+      grouped_by_types: grouped_by_types,
+      format: 'slack',
+    )
+
+    slack(
+      pretext: ":android: A new android version was released\n#{release_notes}", 
+      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+/` |                                |
+| grouped_by_types  | `Hash`                                  | Hash with grouped types with names by issue type. Use de key work "ANY_TYPE" as fallback. |          |                   | `FL_JIRA_RELESE_GROUPED_TYPES` |
+| format            | `slack`, `markdown` , `html` or `plain` | Defines the result format                                    | ✓        | `markdown`        |                                |
+
+
+
+### jira_comment
+
+This action adds comment to the issue keys extracted from your commits since the latest published tag or the issue extract from the name of the branch.
+
+**Usage example:**
+
+```ruby
+def generate_comment_block(version: url:)
+  {
+      "type" => "doc",
+      "version" => 1,
+      "content" => [
+        {
+          "type" => "paragraph",
+          "content" => [
+            {
+              "type" => "text",
+              "text" => "A new Android build is available. (#{version})\n",
+              "marks" => [
+                {
+                  "type" => "strong"
+                }
+              ]
+            },
+            {
+              "type" => "text",
+              "text" => "Download it here",
+              "marks" => [
+                {
+                  "type" => "link",
+                  "attrs" => {
+                    "href" => "#{url}",
+                    "title" => "Download it here"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+end
+
+platform :android do 
+  lane :develop do 
+    # Build a apk for development environment
+    build_develop
+    link_to_download = upload_to_s3	
+    
+    # Comment on issues
+    comment_block = generate_comment_block(
+      version: "v2.5.0",
+      url: "https://some-link-to-download.com"
+    )
+    
+    jira_comment(
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+      ticket_prefix: 'ABC',
+      tag_prefix: "v*",
+      comment_block: comment_block
+    )
+  end
+  
+  lane :staging_validation do 
+    # Build a apk for staging environment
+    # Build a apk for staging environment
+    build_staging
+    link_to_download = upload_to_s3	
+    
+    # Comment on issues
+    comment_block = generate_comment_block(
+      version: "v2.5.0",
+      url: "https://some-link-to-download.com"
+    )
+    
+    jira_comment(
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+      ticket_prefix: 'ABC',
+      extract_from_branch: true,
+      comment_block: comment_block
+    )
+  end
+  
+  lane :release do 
+    # Build a apk for staging environment
+    build_production
+    release_production
+    
+    jira_comment(
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+      ticket_prefix: 'ABC',
+      extract_from_branch: true,
+      comment: "Resolved on version #{version} published #{now_date}"
+    )
+  end
+end
+```
+
+**Arguments:**
+
+| Argument            | Type                | Description                                                  | Optional                                                     | Default           | Env Name                   |
+| ------------------- | ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------------- | -------------------------- |
+| tag_prefix          | `Regex`             | Match prefix to find latest tag. Example: `v*`               | ✓<br />Conflicts with `:extract_from_branch`<br /><br />If you set to extract keys from the branch, it should not be set |                   |                            |
+| 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+/` |                            |
+| extract_from_branch | `Boolean`           | If true it will search for jira issue key in the current branch name. In this case do NOT set `:tag_prefix` | ✓<br />Conflicts with `:tag_prefix`<br /><br />If you set `:tag_prefix`, it should not be set or set to `false` | `false`           |                            |
+| comment             | `String`            | Comment to add to the ticket                                 | ✓<br />Conflicts with `:comment_block`<br /><br />If you set `:comment_block`, it should not be set. |                   |                            |
+| comment_block       | `Hash`              | Comment block to add to the ticket                           | ✓<br />Conflicts with `:comment`<br /><br />If you set `:comment`, it should not be set. |                   |                            |
+
+
+
+### jira_versions
+
+This action searches jira versions and returns the list
+
+**Arguments:**
+
+| Argument   | Type     | Description                                                  | Optional | Env Name             |
+| ---------- | -------- | ------------------------------------------------------------ | -------- | -------------------- |
+| project_id | `String` | The project ID or project key                                |          | `FL_JIRA_PROJECT_ID` |
+| query      | `String` | Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive). | ✓        |                      |
+| order_by   | `String` | Order the results by a field.<br />Valid values: `description`, `-description`, `+description`, `name`, `-name`, `+name`, `releaseDate`, `-releaseDate`, `+releaseDate`, `sequence`, `-sequence`, `+sequence`, `startDate`, `-startDate`, `+startDate` | ✓        |                      |
+| status     | `String` | A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are `released`, `unreleased`, and `archived`. | ✓        |                      |
+
+**Usage example:**
+
+```ruby
+platform :android do 
+  lane :release do 
+    versions = jira_versions(
+      project_id: 'ABC',
+      query: 'app_v2.5.0',
+      status: 'released,archived',
+      username: ENV["FL_JIRA_USERNAME"],
+      password: ENV["FL_JIRA_PASSWORD"],
+      host: ENV["FL_JIRA_HOST"],
+    )
+    
+    puts versions
+	end
+end
+```
 
 
 

data/lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb

@@ -0,0 +1,200 @@
+require 'fastlane/action'
+require_relative '../helper/jira_issues_release_notes_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      FL_JIRA_LAST_TAG ||= :S3_APK_OUTPUT_PATH
+      FL_JIRA_LAST_TAG_HASH ||= :FL_JIRA_LAST_TAG_HASH
+      FL_JIRA_COMMITS_FROM_HASH ||= :FL_JIRA_COMMITS_FROM_HASH
+      FL_JIRA_LAST_KEYS_FROM_COMMITS ||= :FL_JIRA_LAST_KEYS_FROM_COMMITS
+      FL_JIRA_LAST_ISSUES_FROM_COMMITS ||= :FL_JIRA_LAST_ISSUES_FROM_COMMITS
+    end
+
+    class JiraCommentAction < Action
+      def self.run(params)
+        api_version = params[:api_version].to_i
+
+        UI.user_error! "Comments block are only available from api version 3 or earlier" if api_version < 3 and params[:comment_block]
+
+        @jira_helper = Helper::JiraIssuesReleaseNotesHelper.initialize_jira(
+          host: params[:host],
+          api_version: api_version,
+          username: params[:username],
+          password: params[:password],
+          context_path: params[:context_path],
+          disable_ssl_verification: params[:disable_ssl_verification]
+        )
+
+        issues = []
+        if params[:extract_from_branch] then
+          branch = other_action.git_branch
+          ticket_key = Helper::JiraIssuesReleaseNotesHelper.extract_key_from_branch(
+            branch: branch,
+            ticket_prefix: params[:ticket_prefix]
+          )
+
+          unless ticket_key
+            UI.error "Could not extract issue key from branch #{branch}" 
+            false
+          end 
+
+          issues = @jira_helper.get(keys: [ticket_key])
+        else
+
+          issue_key_regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")
+
+          issues = Helper::JiraIssuesReleaseNotesHelper.get_issues_from_commit_after_latest_tag(
+            tag_regex: params[:tag_prefix],
+            tag_version_match: params[:tag_version_match],
+            issue_key_regex: issue_key_regex,
+            debug: params[:debug]
+          )
+        end
+
+        unless !issues.empty?
+          UI.error "No issue could be matched with (#{params[:ticket_prefix]}-\\d+)" 
+          false
+        end 
+
+        @jira_helper.add_comment(
+          comment: params[:comment_block] || params[:comment],
+          issues: issues
+        )
+
+      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
+        "boolean value"
+      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
+        conflict_extraction_method = Proc.new do |other|
+          UI.user_error! "Unexpected conflict with option #{other}" unless [:extract_from_branch, :tag_prefix].include?(other)
+        end
+
+        conflict_comment = Proc.new do |other|
+          UI.user_error! "Unexpected conflict with option #{other}" unless [:comment_block, :comment].include?(other)
+        end
+
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :tag_prefix,
+            description: "Match parameter of git describe. See man page of git describe for more info",
+            optional: true,
+            conflicting_options: [:extract_from_branch],
+            conflict_block: conflict_extraction_method
+          ),
+          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+',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :extract_from_branch,
+            description: "If true it will search for jira issue key in the current branch name. In this case do NOT set :tag_prefix",
+            conflicting_options: [:tag_prefix],
+            conflict_block: conflict_extraction_method,
+            default_value: false,
+            optional: true,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :comment,
+            description: 'Comment to add to the ticket',
+            conflicting_options: [:comment_block],
+            conflict_block: conflict_comment,
+            optional: true,
+            type: String,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :comment_block,
+            description: 'Comment block to add to the ticket',
+            conflicting_options: [:comment],
+            optional: true,
+            conflict_block: conflict_comment,
+            type: Hash,
+          ),
+
+          # 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: :api_version,
+            env_name: 'FL_JIRA_API_VERSION',
+            description:  'Jira api version',
+            default_value: '3',
+            optional: true,
+          ),
+          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