fastlane-plugin-apadmi_grout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5161ef35fb0b4205445e170fb7a84d0f2a72b93f674b1a1d2b9fdd5fafe23cc0
+  data.tar.gz: 659b250f2169b88ab20fe820e44e2bce52bd4445bc2f1397a61e836c784f4b68
+SHA512:
+  metadata.gz: 889806f2dd9318f348fe54ece721b23242084e2aa0699de1866ebed419c8bd6455b120a78919bd141c3a76cb9f0b5334e6a04daadd170ec0c63d9d94d83d150d
+  data.tar.gz: 412782d83d54ae6674f33d810d176b984cccdd73163839c8bfb8a82a4bc4c9d62da01b3a8cb66e0739c5f8543da92f70360c6556a07ad0c34c19e33adb523dc6

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Fastlane Plugin Changelog
+
+## [Unreleased]
+
+## [0.1.0] - 2022-01-23
+
+- Initial release

data/LICENSE

@@ -0,0 +1 @@
+../LICENSE

data/lib/fastlane/plugin/apadmi_grout/actions/find_tickets_to_move_action.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "fastlane/action"
+require "apadmi_grout"
+require_relative "../utils/fastlane_logger"
+
+module Fastlane
+  module Actions
+    # Move JIRA tickets and generate release notes
+    class FindTicketsToMoveAction < Action
+      def self.run(params)
+        logger = FastLane::FastlaneLogger.new
+        logger.message("Finding tickets to move")
+
+        build_tools = Apadmi::Grout::DependencyInjector.new(
+          params[:jira_username],
+          params[:jira_api_token],
+          params[:jira_base_url],
+          params[:jira_context_path],
+          params[:jira_project_key],
+          logger
+        )
+
+        build_tools.find_tickets_to_move_action.run(
+          params[:jira_component_name],
+          params[:jira_status_from],
+          []
+        )
+      end
+
+      def self.description
+        "Convenience lane that finds tickets that are ready to be moved by CI."
+      end
+
+      def self.authors
+        ["samdc@apadmi.com"]
+      end
+
+      def self.available_options
+        [
+          ########## JIRA Auth ##########
+          FastlaneCore::ConfigItem.new(key: :jira_username,
+                                       description: "JIRA username for authentication with JIRA",
+                                       env_name: "JIRA_USERNAME",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA username") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_api_token,
+                                       description: "JIRA api token for authentication with JIRA",
+                                       env_name: "JIRA_API_TOKEN",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA api token") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_project_key,
+                                       description: "JIRA project key",
+                                       env_name: "JIRA_PROJECT_KEY",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA project key, e.g PPT") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_base_url,
+                                       description: "JIRA base url for the organisation",
+                                       env_name: "JIRA_BASE_URL",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA base url") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_context_path,
+                                       description: "JIRA context path whatever that is ¯\\_(ツ)_/¯",
+                                       env_name: "JIRA_CONTEXT_PATH",
+                                       default_value: "",
+                                       type: String,
+                                       optional: true),
+
+          ########## Action Specific ##########
+          FastlaneCore::ConfigItem.new(key: :jira_component_name,
+                                       description: "The JIRA component by which to filter tickets",
+                                       env_name: "JIRA_COMPONENT_NAME",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA component") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_status_from,
+                                       description: "The JIRA status to filter by to find tickets",
+                                       env_name: "JIRA_STATUS_FROM",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA status") unless value
+                                       end,
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/apadmi_grout/actions/generate_release_notes_action.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require "fastlane/action"
+require "apadmi_grout"
+require_relative "../utils/fastlane_logger"
+
+module Fastlane
+  module Actions
+    # Generate release notes based on git changelog
+    class GenerateReleaseNotesAction < Action
+      def self.run(params)
+        logger = FastLane::FastlaneLogger.new
+        logger.message("Generating Release Notes")
+
+        build_tools = Apadmi::Grout::DependencyInjector.new(
+          params[:jira_username],
+          params[:jira_api_token],
+          params[:jira_base_url],
+          params[:jira_context_path],
+          params[:jira_project_key],
+          logger
+        )
+
+        logger.message("Finding changelog between #{params[:oldest_ref]} and #{params[:latest_ref]}")
+        changelog = Fastlane::Actions::ChangelogFromGitCommitsAction.run(
+          pretty: "- %s",
+          between: [params[:oldest_ref], params[:latest_ref]],
+          quiet: false,
+          merge_commit_filtering: "only_include_merges"
+        )
+
+        config = Apadmi::Grout::ReleaseNotesConfig.new(
+          params[:release_notes_title],
+          params[:app_version],
+          params[:min_sdk_int],
+          params[:date_string],
+          params[:tickets_moved_by_build],
+          build_tools.issues_from_changelog_action.run(changelog),
+          params[:commit_hash],
+          params[:ci_build_number],
+          params[:ci_build_url],
+          params[:templates]
+        )
+
+        logger.message("Generating Release Notes")
+        build_tools.generate_release_notes_action.run(config)
+      end
+
+      def self.description
+        "Generate release notes based on git changelog"
+      end
+
+      def self.authors
+        ["samdc@apadmi.com"]
+      end
+
+      def self.return_value
+        "The full release notes generated as one String"
+      end
+
+      def self.available_options
+        [
+          ########## JIRA Auth ##########
+          FastlaneCore::ConfigItem.new(key: :jira_username,
+                                       description: "JIRA username for authentication with JIRA",
+                                       env_name: "JIRA_USERNAME",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA username") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_api_token,
+                                       description: "JIRA api token for authentication with JIRA",
+                                       env_name: "JIRA_API_TOKEN",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA api token") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_project_key,
+                                       description: "JIRA project key",
+                                       env_name: "JIRA_PROJECT_KEY",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA project key, e.g PPT") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_base_url,
+                                       description: "JIRA base url for the organisation",
+                                       env_name: "JIRA_BASE_URL",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA base url") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_context_path,
+                                       description: "JIRA context path whatever that is ¯\\_(ツ)_/¯",
+                                       env_name: "JIRA_CONTEXT_PATH",
+                                       default_value: "",
+                                       type: String,
+                                       optional: true),
+
+          ########## Action Specific ##########
+          FastlaneCore::ConfigItem.new(key: :tickets_moved_by_build,
+                                       description: "Any JIRA tickets who's state was moved by this build",
+                                       default_value: [],
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :release_notes_title,
+                                       description: "The title of the release notes",
+                                       env_name: "RELEASE_NOTES_TITLE",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid project title") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :oldest_ref,
+                                       description: "Changelog between 2 git refs, this is the furthest back of those",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid ref") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :latest_ref,
+                                       description: "Changelog between 2 git refs, this is the most recent of those",
+                                       default_value: "HEAD",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid ref") unless value
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :commit_hash,
+                                       description: "Commit hash of commit being built",
+                                       env_name: "GIT_CLONE_COMMIT_HASH",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :date_string,
+                                       description: "Commit hash of commit being built",
+                                       default_value: Time.now.strftime("%d/%m/%Y"),
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ci_build_number,
+                                       description: "Build number provided by CI",
+                                       env_name: "BITRISE_BUILD_NUMBER", # Probably want to make this not bitrise specific, but this is convenient
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ci_build_url,
+                                       description: "Build URL of CI job",
+                                       env_name: "BITRISE_BUILD_URL", # Probably want to make this not bitrise specific, but this is convenient
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :app_version,
+                                       description: "Current App Version",
+                                       type: String,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid app version") unless value
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :min_sdk_int,
+                                       description: "Minimum OS version supported by the app",
+                                       type: String,
+                                       optional: true,
+                                       default_value: ""),
+          FastlaneCore::ConfigItem.new(key: :templates,
+                                       description: "Release notes templates",
+                                       default_value: Apadmi::Grout::Templates.default,
+                                       type: Apadmi::Grout::Templates)
+        ]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/apadmi_grout/actions/move_jira_tickets_action.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "fastlane/action"
+require "apadmi_grout"
+require_relative "../utils/fastlane_logger"
+
+module Fastlane
+  module Actions
+    # Move JIRA tickets and generate release notes
+    class MoveJiraTicketsAction < Action
+      def self.run(params)
+        logger = FastLane::FastlaneLogger.new
+        logger.message("Moving Jira tickets")
+
+        build_tools = Apadmi::Grout::DependencyInjector.new(
+          params[:jira_username],
+          params[:jira_api_token],
+          params[:jira_base_url],
+          params[:jira_context_path],
+          params[:jira_project_key],
+          logger
+        )
+
+        build_tools.move_jira_tickets_action.run(
+          params[:versions],
+          params[:issues],
+          params[:jira_status_to]
+        )
+      end
+
+      def self.description
+        "Convenience lane that moves all supplied jira tickets to new status and assigns versions."
+      end
+
+      def self.authors
+        ["samdc@apadmi.com"]
+      end
+
+      def self.available_options
+        [
+          ########## JIRA Auth ##########
+          FastlaneCore::ConfigItem.new(key: :jira_username,
+                                       description: "JIRA username for authentication with JIRA",
+                                       env_name: "JIRA_USERNAME",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA username") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_api_token,
+                                       description: "JIRA api token for authentication with JIRA",
+                                       env_name: "JIRA_API_TOKEN",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA api token") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_project_key,
+                                       description: "JIRA project key",
+                                       env_name: "JIRA_PROJECT_KEY",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA project key, e.g PPT") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_base_url,
+                                       description: "JIRA base url for the organisation",
+                                       env_name: "JIRA_BASE_URL",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA base url") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :jira_context_path,
+                                       description: "JIRA context path whatever that is ¯\\_(ツ)_/¯",
+                                       env_name: "JIRA_CONTEXT_PATH",
+                                       default_value: "",
+                                       type: String,
+                                       optional: true),
+
+          ########## Action Specific ##########
+          FastlaneCore::ConfigItem.new(key: :jira_status_to,
+                                       description: "The JIRA status to move the tickets to",
+                                       env_name: "JIRA_STATUS_TO",
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid JIRA status") unless value
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :versions,
+                                       description: "The versions to add to the jira ticket",
+                                       type: Array,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid array of versions") unless value || value.empty
+                                       end,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :issues,
+                                       description: "The issues to be moved",
+                                       type: Array,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Didn't pass a valid array of issues") unless value
+                                       end,
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/apadmi_grout/utils/fastlane_logger.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "fastlane"
+
+module FastLane
+  # A logger compatible with apadmi build tools that hooks into Fastlane's UI
+  class FastlaneLogger
+    def error(msg)
+      FastlaneCore::UI.error(msg)
+    end
+
+    def success(msg)
+      FastlaneCore::UI.success(msg)
+    end
+
+    def message(msg)
+      FastlaneCore::UI.message(msg)
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Fastlane
+  module ApadmiGrout
+    VERSION = "0.0.1"
+  end
+end

data/lib/fastlane/plugin/apadmi_grout.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "fastlane/plugin/apadmi_grout/version"
+
+module Fastlane
+  # Main Buildtools module
+  module ApadmiGrout
+    # Return all .rb files inside the "actions" and "utils" directory
+    def self.all_classes
+      Dir[File.expand_path("**/{actions,utils}/*.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::ApadmiGrout.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-apadmi_grout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apadmi_grout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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:
+- samdc@apadmi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- lib/fastlane/plugin/apadmi_grout.rb
+- lib/fastlane/plugin/apadmi_grout/actions/find_tickets_to_move_action.rb
+- lib/fastlane/plugin/apadmi_grout/actions/generate_release_notes_action.rb
+- lib/fastlane/plugin/apadmi_grout/actions/move_jira_tickets_action.rb
+- lib/fastlane/plugin/apadmi_grout/utils/fastlane_logger.rb
+- lib/fastlane/plugin/apadmi_grout/version.rb
+homepage: https://bitbucket.org/apadmi/apadmi-grout-ruby/
+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.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A fastlane wrapper for the apadmi build tools plugin
+test_files: []