fastlane-plugin-privatexcframeworkpackaging 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71bf838c5ff37939505c2f39d440b707fa2f57e1d39a78afefb49168b419b17c
+  data.tar.gz: 687b13ad0f7fc74ad91cdae469f898495d83922a6605b41052ec95bf2ac09af9
+SHA512:
+  metadata.gz: 3ff55062ccc9a745a36ffcb0cc3770f477b5b640c7ced99bc6f14aba9113231db76cf9ede6f7aedbd27bcfaf1e0c45e0edd859b76fff9eb563da7d1b5862b46b
+  data.tar.gz: b9f0ba2d21b84af074264766f40964478b989cdb7284f55ea8234ce80cd17b9a2c6a26f7af59888e98b9cd1af71271674094aa99c78f56a432111c90029cd2d9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Masami Yamate <m.yamate@mail.yamatte.net>
+
+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,83 @@
+# privatexcframeworkpackaging plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-privatexcframeworkpackaging)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-privatexcframeworkpackaging`, add it to your project by running:
+
+```bash
+fastlane add_plugin privatexcframeworkpackaging
+```
+
+## About privatexcframeworkpackaging
+
+Create a Swift package wrapping XCFramework in a private repository.
+
+## Preparation
+
+### GitHub CLI
+
+To use this plugin, you need to use GitHub CLI. Please authenticate your GitHub CLI account beforehand.
+
+[Github CLI](https://cli.github.com/)
+[Github CLI - gh auth login](https://cli.github.com/manual/gh_auth_login)
+
+### Preparation of the Swift Package Project to be Introduced
+
+This plugin performs the following tasks:
+
+1. It zips the XCFramework contained in the XCFrameworks directory located directly under the root directory.
+2. It automatically creates a release version for binary distribution.
+3. It automatically uploads the XCFramework zip file to the release assets of the release version for distribution.
+4. It automatically updates the Package.swift file using the uploaded zip file in the release assets.
+5. It automatically generates a pull request for the release.
+
+Note that the generation of XCFramework needs to be considered separately using some other method.
+
+### Creation of the XCFrameworks Directory
+
+
+Create a directory named "XCFrameworks" directly under the project directory. Place the XCFramework that you want to distribute in this directory, which you intend to distribute through a private repository.
+
+```sh
+mkdir ./XCFrameworks
+```
+
+### Create a configuration file
+
+Create a file named "PrivatePackageConfig.yml" directly under the project directory.
+
+The following is an example entry for "PrivatePackageConfig.yml". Please modify it accordingly to suit your installation environment.
+
+```yml
+default_branch_name: "main" # Default branch name for repository
+package_name: "PrivateXCFrameworkPackagingExampleFramework" # Package name in Package.swift
+libraries: # Library item settings included in the Product array (multiple settings possible)
+ - name: "SampleFramework" # Library Name
+   targets: # Name of binary target to include in library
+    - "SampleFramework" # binary target name
+binary_targets: # Binary target name. Use the same name as the XCFramework name.
+ - "SampleFramework" # XCFramework name
+```
+
+## Example
+
+For sample projects, please refer to the repository below.
+[PrivateXCFrameworkPackagingExampleFramework](https://github.com/MasamiYamate/PrivateXCFrameworkPackagingExampleFramework)
+
+## 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/privatexcframeworkpackaging/actions/privatexcframeworkpackaging_action.rb

@@ -0,0 +1,246 @@
+require 'fastlane/action'
+require 'yaml'
+
+module Fastlane
+  module Actions
+    class PrivatexcframeworkpackagingAction < Action
+      def self.run(params)
+        # Configの読み込み
+        config = load_config
+        make_libraries(config)
+        # 事前準備
+        prepare_binary_upload(config)
+        # タグを取得する
+        latest_tag_result = fetch_latest_tag
+        # binary配布用のVersionを発行する
+        asset_version = make_binary_release_version(latest_tag_result)
+        # リリースアセットにUpするZipを生成する
+        make_xcframework_xip
+        # Checksumを生成
+        checksum_items = make_xcframework_checksum(config)
+        # Upload
+        upload_binary_for_release_asset(asset_version)
+        asset_urls = fetch_release_asset_urls(asset_version)
+
+        # ここからリリース用のPR作成フロー
+        # 作業ブランチの作成
+        new_version = asset_version.split('_').shift
+        branch_name = checkout_package_update_branch(new_version)
+        # Package.swiftの更新
+        update_package(config, checksum_items, asset_urls)
+        # Pull requestの発行
+        make_binary_update_pull_request(config, new_version, branch_name)
+      end
+
+      # 事前準備
+      def self.prepare_binary_upload(config)
+        # 既に作業用ディレクトリがある場合は削除する
+        `rm -rf ./Build/Zip`
+        # Baseブランチへの切り替え
+        basebranch_name = config['defaultbranch_name']
+        # 最新の状態を取得する
+        `git checkout #{basebranch_name} ; git pull`
+        # 最新の状態を取得する
+        `git checkout #{basebranch_name} ; git pull`
+        # XCFrameworkのディレクトリの確認
+        unless Dir.exist?('./XCFrameworks')
+          throw Exception.new('There is no directory to save XCFramework')
+        end
+        # git diffがないことを確認する
+        git_diff_exit_code = `git diff --exit-code --quiet & echo $?`.chomp
+        if git_diff_exit_code != '0'
+          throw Exception.new('There are differences')
+        end
+      end
+
+      # binaryリリース用のバージョンを発行する
+      def self.make_binary_release_version(latest_tag_result)
+        split_version_items = latest_tag_result.split('.')
+        # マイナーバージョンUp
+        minor_version = split_version_items[1].to_i + 1
+        new_version = "#{split_version_items[0]}.#{minor_version}.#{split_version_items[2].sub(/_.*/m, '')}"
+        # リリースアセット用のVersionの発行
+        now_time = Time.now
+        ymd_string = "#{format('%04<number>d', number: now_time.year)}#{format('%02<number>d', number: now_time.month)}#{format('%02<number>d', number: now_time.day)}"
+        hms_string = "#{format('%02<number>d', number: now_time.hour)}#{format('%02<number>d', number: now_time.min)}#{format('%02<number>d', number: now_time.sec)}"
+        asset_version = "#{new_version}_binary_#{ymd_string}_#{hms_string}"
+        `bundle exec gh release create #{asset_version}`
+        return asset_version
+      end
+
+      # 各frameworkをZipに圧縮する
+      def self.make_xcframework_xip
+        xcframeworks_path = './XCFrameworks'
+        work_dir_path = './Build/Zip'
+        # 作業用ディレクトリの作成
+        `mkdir -p #{work_dir_path}`
+        Dir.foreach(xcframeworks_path) do |item|
+          next if item == '.' || item == '..' || item == '.DS_Store'
+
+          zip_file_path = "#{work_dir_path}/#{item}.zip"
+          xcframework_path = "#{xcframeworks_path}/#{item}"
+          `zip -r -X #{zip_file_path} #{xcframework_path}`
+        end
+      end
+
+      # 各XCFramework zipのchecksumを取得する
+      def self.make_xcframework_checksum(config)
+        result = {}
+        zip_dir = './Build/Zip'
+        Dir.foreach(zip_dir) do |item|
+          next if item == '.' || item == '..' || item == '.DS_Store'
+
+          framework_path = "#{zip_dir}/#{item}"
+          checksum = `shasum -a 256 #{framework_path}`.split( ).shift
+          framework_name = extraction_framework_name(item)
+          result[framework_name] = checksum
+        end
+        return result
+      end
+
+      # Package更新用のブランチをチェックアウト
+      def self.checkout_package_update_branch(new_version)
+        # Version発行後の最新の状態を取得する
+        `git pull`
+        # 作業用ブランチの作成
+        branch_name = "feature/update-#{new_version}"
+        current_branch = `git branch --contains | cut -d ' ' -f 2`
+        if branch_name != current_branch
+          `git checkout -b #{branch_name}`
+        end
+        return branch_name
+      end
+
+      # Update用のPull Requestを発行する
+      def self.make_binary_update_pull_request(config, new_version, branch_name)
+        `git add .`
+        commit_message = "Update binary #{new_version}"
+        `git commit -m "#{commit_message}"`
+        `git push --set-upstream origin #{branch_name}`
+
+        basebranch_name = config['basebranch_name']
+        title = "Update #{new_version}"
+        body = "Update XCFrameworks Version #{new_version}"
+        `bundle exec gh pr create --base "#{basebranch_name}" --head "#{branch_name}" --title "#{title}" --body "#{body}"`
+      end
+
+      # binary targetの各項目を生成する
+      def self.make_binary_targets(config, checksum_items, asset_urls)
+        result = []
+        binary_target_template = fetch_template('package_binary_target_template.txt')
+        binary_targets = config['binary_targets']
+        for binary_target_name in binary_targets
+          checksum = checksum_items[binary_target_name]
+          asset_url = "#{asset_urls[binary_target_name]}.zip"
+          binary_target_item = binary_target_template.gsub('${binary_target_name}', binary_target_name).gsub('${binary_target_url}', asset_url).gsub('${binary_check_sum}', checksum)
+          result.push(binary_target_item)
+        end
+        return result
+      end
+
+      # libraryの各項目を生成する
+      def self.make_libraries(config)
+        result = []
+        library_template = fetch_template('package_library_item_template.txt')
+        libraries = config['libraries']
+        for library in libraries
+          name = library['name']
+          targets = library['targets'].map { |target| '\'' + target + '\'' }.join(',')
+          library_item = library_template.gsub('${library_name}', name).gsub('${library_targets}', targets)
+          result.push(library_item)
+        end
+        return result
+      end
+
+      # Package.swiftを更新する
+      def self.update_package(config, checksum_items, asset_urls)
+        binary_targets = make_binary_targets(config, checksum_items, asset_urls).join(',')
+        libraries = make_libraries(config).join(',')
+        package_name = config['package_name']
+        update_package_template = fetch_template('package_base_template.txt')
+        update_package_txt = update_package_template.gsub('${package_name}', package_name).gsub('${product_items}', libraries).gsub('${binary_targets}', binary_targets)
+        open('./Package.swift', 'w') do |file|
+          file.puts(update_package_txt)
+        end
+      end
+
+      # binaryをUploadする
+      def self.upload_binary_for_release_asset(tag)
+        zip_dir = './Build/Zip'
+        Dir.foreach(zip_dir) do |item|
+          next if item == '.' || item == '..' || item == '.DS_Store'
+          
+          framework_path = "#{zip_dir}/#{item}"
+          `bundle exec gh release upload #{tag} #{framework_path}`
+        end
+      end
+
+      # 設定ファイルを取得する
+      def self.load_config
+        return open('PrivatePackageConfig.yml', 'r') { |file| YAML.load(file) }
+      end
+
+      # Upload済みのRelease Assetsのapi urlを取得する
+      def self.fetch_release_asset_urls(tag)
+        result = {}
+        assets_json = `bundle exec gh release view #{tag} --json assets`
+        assets_hash = JSON.load(assets_json)
+        assets = assets_hash['assets']
+        for asset in assets
+          api_url = asset['apiUrl']
+          framework_name = extraction_framework_name(asset['name'])
+          result[framework_name] = api_url
+        end
+        return result
+      end
+
+      # Package.swift更新用の各テンプレートファイルを抽出する
+      def self.fetch_template(file_name)
+        directory_path_items = __dir__.split(File::SEPARATOR)
+        directory_path_items.pop
+        plugin_root_dir_path = directory_path_items.join(File::Separator)
+        template_file = open("#{plugin_root_dir_path}/template/#{file_name}", 'r')
+        return template_file.read
+      end
+
+      # 拡張子付きのファイル名からFramework名称を抽出する
+      def self.extraction_framework_name(file_name)
+        # hogeFuga.xcframeworkやhogeFuga.xcframework.zipからファイル名を抽出する
+        return file_name.split('.').shift
+      end
+
+      # 最新のタグを取得する
+      def self.fetch_latest_tag
+        # タグを取得する
+        latest_tag_result = `git describe --tags --abbrev=0`.chomp
+        if latest_tag_result == ''
+          latest_tag_result = '0.0.0'
+        end
+        return latest_tag_result
+      end
+
+      def self.description
+        'Generate a Swift package using the XCFramework uploaded to the Release assets of a private repository.'
+      end
+
+      def self.authors
+        ['Masami Yamate']
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        'Generate a Swift package using the XCFramework uploaded to the Release assets of a private repository.'
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/privatexcframeworkpackaging/template/package_base_template.txt

@@ -0,0 +1,14 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "${package_name}",
+    products: [
+        ${product_items}
+    ],
+    targets: [
+        ${binary_targets}
+    ]
+)

data/lib/fastlane/plugin/privatexcframeworkpackaging/template/package_binary_target_template.txt

@@ -0,0 +1,5 @@
+.binaryTarget(
+    name: "${binary_target_name}",
+    url: "${binary_target_url}",
+    checksum: "${binary_check_sum}"
+)

data/lib/fastlane/plugin/privatexcframeworkpackaging/template/package_library_item_template.txt

@@ -0,0 +1,4 @@
+.library(
+    name: "${library_name}",
+    targets: [${library_targets}]
+)

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Privatexcframeworkpackaging
+    VERSION = "0.3.2"
+  end
+end

data/lib/fastlane/plugin/privatexcframeworkpackaging.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/privatexcframeworkpackaging/version'
+
+module Fastlane
+  module Privatexcframeworkpackaging
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions}/*.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::Privatexcframeworkpackaging.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-privatexcframeworkpackaging
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Masami Yamate
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-10 00:00:00.000000000 Z
+dependencies:
+- !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.217.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.217.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: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+- !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: yamate.inquiry@mail.yamatte.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/privatexcframeworkpackaging.rb
+- lib/fastlane/plugin/privatexcframeworkpackaging/actions/privatexcframeworkpackaging_action.rb
+- lib/fastlane/plugin/privatexcframeworkpackaging/template/package_base_template.txt
+- lib/fastlane/plugin/privatexcframeworkpackaging/template/package_binary_target_template.txt
+- lib/fastlane/plugin/privatexcframeworkpackaging/template/package_library_item_template.txt
+- lib/fastlane/plugin/privatexcframeworkpackaging/version.rb
+homepage: https://github.com/MasamiYamate/fastlane-plugin-privatexcframeworkpackaging
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Generate a Swift package using the XCFramework uploaded to the Release assets
+  of a private repository.
+test_files: []