fastlane-plugin-kmm_pusher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc0dc39bb6d7296db350e7e9c7e34ba124dfeeea36e447392524bd6ebab7c9ad
+  data.tar.gz: 9cff20f4ad7cb9480541516c72704f2c97a986626565f3a25db2b8378e243809
+SHA512:
+  metadata.gz: d6579a39529f30de6625e51bb5a0e1965f1722ca64c010c48e82bc85490666de10289e0d6783509dd4be2911242b25fe52c1b2119fa9c7339d36ef571a87145d
+  data.tar.gz: 62ab3f6d33b9d4217b0f26aeeff5e0685a839980cf24d1adcf3168a317acee9b6bb1033a58a2b5d410bc7605fbd475801d057f2614da44ce25e33d30008ef385

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Yazan Tarifi <yazantarifi989@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,17 @@
+## Fastlane Plugin: KMM Pusher 🚀
+
+A Fastlane plugin to streamline the build, distribution, and notification process for Kotlin Multiplatform (KMM) projects. This plugin integrates seamlessly with Fastlane to automate your KMM workflows and keep your team informed via Slack.
+
+## Features ✨
+1. Build KMM Projects: Automate the build process for Kotlin Multiplatform projects.
+2. Upload Files to Slack: Easily upload build artifacts (.aar, .zip, .xcframework) to Slack channels.
+3. Notify Teams: Send build status updates and notifications to Slack channels.
+4. Customizable: Configure the plugin to suit your project's needs.
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-kmm_pusher)
+
+Commands
+```
+gem build fastlane-plugin-kmm_pusher.gemspec   
+gem install ./fastlane-plugin-kmm_pusher-0.0.14.gem  
+```

data/lib/fastlane/plugin/kmm_pusher/actions/kmm_pusher_action.rb

@@ -0,0 +1,105 @@
+require 'fastlane/action'
+require_relative '../helper/kmm_pusher_helper'
+
+module Fastlane
+  module Actions
+    class KmmPusherAction < Action
+      def self.run(params)
+        UI.message("Fastlane Kotlin Multiplatform Pusher Started ...")
+
+        is_xc_framework_enabled = params[:is_xc_framework_enabled]
+        service_type = params[:service_type]
+        project_name = params[:project_name]
+        is_commit_enabled = params[:is_commit_enabled]
+        commit_message = params[:commit_message]
+        slack_channel = params[:slack_channel]
+        slack_app_token = params[:slack_app_token]
+
+        Helper::KmmPusherHelper.start_plugin(
+          project_name,
+          service_type,
+          is_xc_framework_enabled,
+          is_commit_enabled,
+          commit_message,
+          slack_channel,
+          slack_app_token
+        )
+      end
+
+      def self.description
+        "Kotlin Multiplatform Mobile Plugin to Collect Android and IOS Builds to Push them on Slack"
+      end
+
+      def self.authors
+        ["Yazan Tarifi"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "Build Kotlin Multiplatform Mobile Library Projects and Generate Builds to Push them on Slack Channels to be able to Track All KMM Library Builds"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :project_name,
+            env_name: "KMM_PUSHER_PROJECT_NAME",
+            description: "Module Name of the Library that you Generate Builds on",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :is_xc_framework_enabled,
+            env_name: "KMM_PUSHER_XC_TRACK_ENABLED",
+            description: "Decide which Builds Enabled for XCFramework or Normal Framework",
+            optional: false,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :service_type,
+            env_name: "KMM_PUSHER_SERVICE_TYPE",
+            description: "Service Type to Push the Builds on (slack, discord, telegram)",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :is_commit_enabled,
+            env_name: "KMM_PUSHER_COMMIT_ENABLED",
+            description: "Boolean Value to Decide if the Commit after Build enabled or Not",
+            optional: true,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :commit_message,
+            env_name: "KMM_PUSHER_COMMIT_MESSAGE",
+            description: "Send the Commit Message when Push the Build Results",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :slack_channel,
+            env_name: "KMM_PUSHER_SLACK_CHANNEL",
+            description: "Channel name that KMM Pusher gonna Push the Builds on",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :slack_app_token,
+            env_name: "KMM_PUSHER_APP_TOKEN",
+            description: "Application Bot Name that KMM Pusher Push the Builds on",
+            optional: true,
+            type: String
+          ),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/kmm_pusher/helper/kmm_pusher_helper.rb

@@ -0,0 +1,208 @@
+require 'fastlane_core/ui/ui'
+require 'zip'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class KmmPusherHelper
+      def self.start_plugin(
+        project_name,
+        service_type,
+        is_xc_framework_enabled,
+        is_commit_enabled,
+        commit_message,
+        slack_channel,
+        slack_app_token
+      )
+
+        # Pre Check Plugin Params before Start the Plugin
+        raise PluginMissingParamsException, print_error_message("project_name is required in configuration!") if project_name.nil? || project_name.empty?
+        raise PluginMissingParamsException, print_error_message("service_type is required in configuration!") if service_type.nil? || service_type.empty?
+
+        # Pre Check on Slack Configurations if Service Type is Slack
+        if service_type == "slack"
+          raise PluginMissingParamsException, print_error_message("slack_channel is required in configuration!") if slack_channel.nil? || slack_channel.empty?
+          raise PluginMissingParamsException, print_error_message("slack_app_token is required in configuration!") if slack_app_token.nil? || slack_app_token.empty?
+        end
+
+        # Print Plugin Params Start
+        print_log_message("KMM Pusher Started with Project #{project_name} and Service Type #{service_type}")
+
+        # 1. Remove Prev Build for Android and IOS
+        delete_prev_builds(project_name)
+
+        # 2. Start Building the Library By Project Module
+        build_library_module(project_name, is_xc_framework_enabled)
+
+        # 3. Find Build Paths
+        move_builds_to_root_path(project_name)
+
+        # 4. Compress Files to Zip Files
+        if is_xc_framework_enabled
+          compress_files(project_name, "xcframework")
+        else
+          compress_files(project_name, "framework")
+        end
+
+        # 5. Check if the Git Commits Enabled after Build Push the Builds to Repository
+        if is_commit_enabled
+          push_build(commit_message)
+        end
+
+        # 6. Push the Builds to Service
+        if service_type == "slack"
+          push_slack_build(slack_channel, project_name, is_xc_framework_enabled, slack_app_token)
+        end
+
+      end
+
+      def self.push_slack_build(slack_channel, project_name, is_xc_framework_enabled, token)
+        if is_xc_framework_enabled
+          upload_file_to_slack(
+            "#{get_current_working_directory}/#{project_name}.xcframework.zip",
+            slack_channel,
+            "A new Build Pushed for IOS Client with XCFramework",
+            token
+          )
+        else
+          upload_file_to_slack(
+            "#{get_current_working_directory}/#{project_name}.framework.zip",
+            slack_channel,
+            "A new Build Pushed for IOS Client with Framework",
+            token
+          )
+        end
+
+        upload_file_to_slack(
+          "#{get_current_working_directory}/#{project_name}-debug.aar",
+          slack_channel,
+          "A new Build Pushed for Android Client with Framework",
+          token
+        )
+      end
+
+      def self.get_current_working_directory
+        Dir.pwd
+      end
+
+      def self.upload_file_to_slack(file_path, channel, initial_comment = nil, slack_token)
+        Actions.sh("node pusher.js #{file_path} \"#{channel}\" \"#{initial_comment}\" #{slack_token}")
+      end
+
+      def self.compress_files(project_name, extention)
+        # Define the file to compress
+        file_to_compress = "#{project_name}.#{extention}"
+        zip_file = "#{file_to_compress}.zip"
+
+        # Create the ZIP file
+        Zip::File.open(zip_file, Zip::File::CREATE) do |zip|
+          if File.directory?(file_to_compress)
+            # Add all files in the directory recursively
+            Dir["#{file_to_compress}/**/**"].each do |file|
+              zip.add(file.sub("#{file_to_compress}/", ""), file)
+            end
+          else
+            # Add a single file
+            zip.add(File.basename(file_to_compress), file_to_compress)
+          end
+        end
+
+        print_log_message("Successfully created #{zip_file}")
+      end
+
+      def self.push_build(commit_message)
+        Actions.sh("git add .")
+        Actions.sh("git commit -m \"#{commit_message}\" ")
+
+        current_branch = get_git_reference
+        Actions.sh("git push origin #{current_branch}")
+      end
+
+      def self.get_git_reference
+        # Try to get the first tag name
+        first_tag = `git describe --tags --abbrev=0 2>&1`.strip
+
+        if $?.success?
+          first_tag
+        else
+          # Fall back to the current branch name
+          current_branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip
+          current_branch
+        end
+      end
+
+      def self.move_builds_to_root_path(project_name)
+        print_log_message("Start Moving Builds from Build Folder to Root Folder")
+
+        directory = Actions.sh("pwd").delete(" \t\r\n")
+        iosSourceDirectory = directory + "/#{project_name}/build/XCFrameworks/release/#{project_name}.xcframework"
+        androidBuildDirectory = directory + "/#{project_name}/build/outputs/aar/#{project_name}-debug.aar"
+
+        print_log_message("Current Working Directory : #{directory}")
+        print_log_message("IOS Working Directory : #{iosSourceDirectory}")
+        print_log_message("Android Working Directory : #{androidBuildDirectory}")
+
+        Actions.sh("mv " + iosSourceDirectory + " " + directory + "/#{project_name}.xcframework")
+        Actions.sh("mv " + androidBuildDirectory + " " + directory + "/#{project_name}-debug.aar")
+      end
+
+      def self.build_library_module(project_name, is_xc_framework_enabled)
+        Actions.sh("./gradlew #{project_name}:clean")
+        Actions.sh("./gradlew #{project_name}:assemble")
+        if is_xc_framework_enabled
+          Actions.sh("./gradlew #{project_name}:assembleXCFramework")
+        end
+      end
+
+      def self.delete_prev_builds(project_name)
+        begin
+          Actions.sh("rm ./#{project_name}-debug.aar")
+        rescue Exception
+          # Ignored if Not Exists
+        end
+
+        begin
+          Actions.sh("rm -rf ./#{project_name}.framework")
+        rescue Exception
+          # Ignored if Not Exists
+        end
+
+        begin
+          Actions.sh("rm -rf ./#{project_name}.xcframework")
+        rescue Exception
+          # Ignored if Not Exists
+        end
+
+        begin
+          Actions.sh("rm -rf ./#{project_name}.framework.zip")
+        rescue Exception
+          # Ignored if Not Exists
+        end
+
+        begin
+          Actions.sh("rm -rf ./#{project_name}.xcframework.zip")
+        rescue Exception
+          # Ignored if Not Exists
+        end
+      end
+
+      def self.print_log_message(message)
+        puts " ---------------------------------------- "
+        puts " -------------- #{message} -------------- "
+        puts " ---------------------------------------- "
+      end
+
+      def self.print_error_message(message)
+        "\e[31m ------ [#{message}] ------ \e[0m"
+      end
+
+      def self.show_message
+        UI.message("Kotlin Pusher Plugin Started Message")
+      end
+    end
+  end
+end
+
+class PluginMissingParamsException < StandardError
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module KmmPusher
+    VERSION = "1.0.0"
+  end
+end

data/lib/fastlane/plugin/kmm_pusher.rb

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

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-kmm_pusher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yazan Tarifi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-09 00:00:00.000000000 Z
+dependencies: []
+description:
+email: yazantarifi989@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/kmm_pusher.rb
+- lib/fastlane/plugin/kmm_pusher/actions/kmm_pusher_action.rb
+- lib/fastlane/plugin/kmm_pusher/helper/kmm_pusher_helper.rb
+- lib/fastlane/plugin/kmm_pusher/version.rb
+homepage: https://github.com/Yazan98/KMM-Pusher
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Kotlin Multiplatform Mobile Plugin to Collect Android and IOS Builds to Push
+  them on Slack
+test_files: []