xcode_fastlane 1.0.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b95323aded86c129ece9f2169b98007e0d4d72c2e864363328c167d81fb3c5b3
-  data.tar.gz: a4d59475d34dae4288b5c570f81bd92fce8ebf3fda0f86ae4f21c3563d4d37d7
+  metadata.gz: 2e2663ea7a9423640263850234ef3e7d77e90ed560f0e3c075370ee1c090c2cc
+  data.tar.gz: 4cfa19a676af15c29b0bcc853e0b38ed73b4c2bb77d846323e500cb0bf65fda7
 SHA512:
-  metadata.gz: 779185baf85ba1cf858c53557c70eb9b8b0c638f306739adf203f9f5fba9bfb3a7cab426dc3f14c337d85e1bdd5d5372e7ac7d8dd9a37868d71b5df5f269a090
-  data.tar.gz: bcbd8158ed2a548b9d64cbb759e3948dc2f88d6b3ae91c9331c06e1d16f9d1d42690c19b4b3a65a228614972156096b861c440e63540dc32094417d2cfe23c49
+  metadata.gz: 93dbf3ec6a82312fa73341ce2ae406ebe2f33e27f8958c512386f5ede94572ec8124e864dad04737a0dcbdde133053846e38b3e6f3c6e5ca36ce51394a64e4dd
+  data.tar.gz: f9071ea3c917e26da59a39ff2332117a819c6cdfba7e6c9845637241c65947de7a3bfd7105c19d29139570f4bcfc59cf0e42300c70db072ee78950d4c132dd6c

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.2.0 (2024-05-21)
+
+### Features
+
+- new fastfile with proper lane setup
+
+## 1.1.0 (2024-05-17)
+
+### Features
+
+- add method to switch to new git branch
+
 ## 1.0.3 (2024-05-14)
 
 ### Bug fixes

data/fastlane/Fastfile

@@ -6,56 +6,150 @@ opt_out_usage
 default_platform(:ios)
 
 platform :ios do
-  # https://www.runway.team/blog/how-to-set-up-a-ci-cd-pipeline-for-your-ios-app-fastlane-github-actions
-  desc "Load AppStore Connect API Key information to use in subsequent lanes"
-  lane :load_api_key do
-    app_store_connect_api_key(
-      key_id: ENV.fetch("APPSTORE_CONNECT_API_KEY_ID", nil),
-      issuer_id: ENV.fetch("APPSTORE_CONNECT_API_KEY_ISSUER_ID", nil),
-      key_content: ENV.fetch("APPSTORE_CONNECT_API_KEY_P8", nil),
-      is_key_content_base64: true,
-      in_house: false # detecting this via AppStore Connect private key not currently supported
-    )
+  before_all do
+    Dotenv.load ".env.ios"
+  end
+end
+
+platform :macos do
+  before_all do
+    Dotenv.load ".env.mac"
+  end
+end
+
+platform :ios do
+
+  desc "Create app on Apple Developer and App Store Connect"
+  lane :create_app do
+    create_app_online # produce
+  end
+
+  desc "Prepare Xcode project for use with match code signing"
+  lane :prepare_for_match do
+    update_code_signing_settings
+    match
   end
 
-  desc "Register app on Apple Developer Portal and AppStore Connect"
-  lane :register do
-    create_app_online( # produce
-      language: "en-US",
-      # com.example.AppName => com.example.apps.AppName.ios
-      sku: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)
-        .split(".").insert(2, "apps").append("ios").join("."),
-      enable_services: {}
+  desc "Prepare app for use with auto versioning.\n"
+  desc "Param `commit: true` to commit changes.\n"
+  desc "Required once locally."
+  lane :prepare_for_versioning do |options|
+    prepare_versioning
+    if options[:commit]
+      git_commit(allow_nothing_to_commit: true,
+                message: "build: update versioning system",
+                path: ["*.plist", "*.pbxproj"])
+    end
+  end
+
+  desc "Sync certificates"
+  lane :sync_certs_and_profiles do |options|
+    if options[:auto]
+      get_certificates           # invokes cert
+      get_provisioning_profile   # invokes sigh
+    else
+      sync_code_signing({readonly: true, type: "appstore"}) # invokes match
+      update_code_signing_settings(
+        profile_name: lane_context[SharedValues::MATCH_PROVISIONING_PROFILE_MAPPING][ENV["APP_IDENTIFIER"]],
+      )
+    end
+  end
+
+  desc "Write release notes"
+  lane :write_release_notes do |options|
+    content = options[:text]
+    UI.user_error!("No changelog passed.") if content.nil?
+
+    release_notes_file = Dir.glob("**/default/release_notes.txt").first
+    UI.user_error!("No default release notes file found.") if release_notes_file.nil?
+
+    File.write(release_notes_file, content)
+    return release_notes_file
+  end
+
+  desc "Ensure to be on a release branch for the next release"
+  lane :ensure_release_branch_and_version do
+    unless branch_name.start_with?(ENV["RELEASE_BRANCH_PREFIX"])
+      if get_versioning_info
+        new_version = lane_context[SharedValues::SEMVER_NEW_VERSION]
+        UI.message("New version: #{new_version}")
+
+        # new branch
+        XcodeFastlane.checkout_branch("#{ENV["RELEASE_BRANCH_PREFIX"]}#{new_version}")
+
+        file = write_release_notes(text: lane_context[SharedValues::SEMVER_NEW_CHANGELOG])
+        git_add(path: file)
+
+        # Create version via commitizen
+        semantic_bump
+      else
+        UI.user_error!("No new version to bump.")
+      end
+    end
+  end
+
+  desc "Create ipa"
+  lane :build do
+    sync_certs_and_profiles
+    # Commit changes made by match
+    git_commit(
+      allow_nothing_to_commit: true,
+      message: "build: update certificate and provision setting",
+      path: ["*.plist", "*.pbxproj"]
     )
+
+    # Increases the build number by 1
+    old_build_number = get_build_number
+    increment_build_number
+
+    # Creates a signed file
+    build_app # invokes gym
+
+    commit_version_bump(message: "bump: build #{old_build_number} → #{lane_context[SharedValues::BUILD_NUMBER]}")
   end
 
-  desc "Generate and upload new localized screenshots and metadata"
-  desc "Params: send_success: boolean, indicating whether to send a success message via slack"
-  lane :upload_appstore_data do |options|
+  desc "Take screenshots."
+  lane :screenshot do
     capture_screenshots(scheme: ENV.fetch("IOS_SCHEME", nil))
-    load_api_key
-    register
-    upload_to_app_store( # deliver
-      skip_binary_upload: true,
-      skip_screenshots: false,
-      skip_metadata: false,
-      skip_app_version_update: false,
-      overwrite_screenshots: true,
-      force: true,
-      # Precheck cannot check In-app purchases with the App Store Connect API Key (yet).
-      precheck_include_in_app_purchases: false,
-      app_review_information: {
-        first_name: ENV.fetch("FASTLANE_REVIEW_FIRSTNAME", nil),
-        last_name: ENV.fetch("FASTLANE_REVIEW_LASTNAME", nil),
-        phone_number: ENV.fetch("FASTLANE_REVIEW_PHONE", nil),
-        email_address: ENV.fetch("FASTLANE_REVIEW_EMAIL", nil)
-      }
-    )
+  end
+
+  desc "Upload to App Store."
+  lane :upload_testflight do
+    app_store_connect_api_key
+    testflight # invokes pilot
+  end
+
+  desc "Upload to App Store."
+  lane :upload_appstore do
+    app_store_connect_api_key
+    upload_to_app_store # invokes deliver
+  end
+
+  desc "Create release branch, build, and upload to TestFlight."
+  lane :beta do
+    run_tests # invokes scan
+    ensure_release_branch_and_version
+    build
+    upload_testflight
+  rescue StandardError => e
+    on_error(e)
+    raise
+  else
+    on_success("Beta build finished and uploaded to TestFlight")
+  end
+
+  desc "Create app, screenshot, build and upload."
+  lane :release_app do
+    create_app
+    ensure_release_branch_and_version
+    build
+    screenshot
+    upload_appstore
   rescue StandardError => e
     on_error(e)
     raise
   else
-    on_success("Data uploaded to AppStore Connect") if options[:send_success]
+    on_success("Build and upload to AppStore finished.")
   end
 end
 
@@ -67,6 +161,7 @@ def on_success(message, **_props)
     success: true,
     slack_url: ENV.fetch("FASTLANE_SLACK_URL", nil),
     payload: {
+      "Build Number" => lane_context[SharedValues::BUILD_NUMBER],
       "CI Build Number" => ENV.fetch("CI_BUILD_NUMBER", nil),
       "CI Workflow" => ENV.fetch("CI_WORKFLOW", nil)
     }
@@ -81,6 +176,7 @@ def on_error(exception)
     success: false,
     slack_url: ENV.fetch("FASTLANE_SLACK_URL", nil),
     payload: {
+      "Build Number" => lane_context[SharedValues::BUILD_NUMBER],
       "CI Build Number" => ENV.fetch("CI_BUILD_NUMBER", nil),
       "CI Workflow" => ENV.fetch("CI_WORKFLOW", nil)
     },
@@ -95,3 +191,15 @@ def on_error(exception)
     }
   )
 end
+
+private_lane :get_app_category do
+  app_category = nil
+  project = Xcodeproj::Project.open("../#{ENV["PROJECT_XCODEPROJ"]}")
+  project.objects.each do |object|
+    if object.isa == "XCBuildConfiguration" && object.name == "Release"
+      app_category = object.build_settings["INFOPLIST_KEY_LSApplicationCategoryType"]
+      break if app_category
+    end
+  end
+  app_category
+end

data/lib/xcode_fastlane/cli.rb

@@ -13,12 +13,21 @@ module XcodeFastlane
 
     desc "init", "Initialize fastlane setup"
     def init
-      copy_file ".gitignore"
-      copy_file "Gemfile"
-      copy_file "fastlane/Appfile"
-      copy_file "fastlane/Deliverfile"
-      copy_file "fastlane/Fastfile"
-      copy_file "fastlane/Snapfile"
+      %w[
+        .gitignore
+        Gemfile
+        fastlane/.env.beta
+        fastlane/.env.ios
+        fastlane/.env.mac
+        fastlane/.env.release
+        fastlane/Appfile
+        fastlane/Fastfile
+        fastlane/Snapfile
+      ].each do |file|
+        copy_file file
+      end
     end
+
+    # TODO: run deliver init and overwrite with Deliverfile
   end
 end

data/lib/xcode_fastlane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XcodeFastlane
-  VERSION = "1.0.3"
+  VERSION = "1.2.0"
 end

data/lib/xcode_fastlane.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "xcode_fastlane/version"
+require "git"
 require "xcodeproj"
 
 # Main module for helper methods and CLI.
@@ -10,6 +11,18 @@ module XcodeFastlane
     @project ||= Xcodeproj::Project.open(Pathname.glob("../*.xcodeproj").first)
   end
 
+  # Returns the first target
+  def self.target
+    project.targets.first
+  end
+
+  # Generates an SKU
+  # Requires environment: PRODUCE_PLATFORM to be set.
+  def self.sku
+    platform = ENV.fetch("PRODUCE_PLATFORM")
+    CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) + ".#{platform}"
+  end
+
   # Returns product bundle identifier for the given target or the first one found, if target_name is nil.
   #
   # Arguments:
@@ -25,4 +38,10 @@ module XcodeFastlane
     product = project.products.select { |p| p.explicit_file_type == "wrapper.application" }.first
     product.path.split(".").first
   end
+
+  # Creates and checks out a new branch
+  def self.checkout_branch(name)
+    git = Git.open(".")
+    git.branch(name).checkout
+  end
 end

data/templates/fastlane/.env.ios

@@ -0,0 +1,5 @@
+PRODUCE_LANGUAGE = en-US
+PRODUCE_PLATFORM = ios
+PRODUCE_SKU = ${APP_IDENTIFIER}.ios
+MATCH_PLATFORM = ios
+DELIVER_PLATFORM = ios

data/templates/fastlane/.env.mac

@@ -0,0 +1,5 @@
+PRODUCE_LANGUAGE = en-US
+PRODUCE_PLATFORM = macos
+PRODUCE_SKU = ${APP_IDENTIFIER}.macos
+MATCH_PLATFORM = macos
+DELIVER_PLATFORM = osx

data/templates/fastlane/Appfile

@@ -1,14 +1,16 @@
 require "xcode_fastlane"
 
 mandatory_environment = %w[
-  APPSTORE_CONNECT_API_KEY_ID
-  APPSTORE_CONNECT_API_KEY_ISSUER_ID
-  APPSTORE_CONNECT_API_KEY_P8
+  APP_STORE_CONNECT_KEY_KEY_ID
+  APP_STORE_CONNECT_KEY_ISSUER_ID
+  APP_STORE_CONNECT_KEY_KEY
   FASTLANE_REVIEW_EMAIL
   FASTLANE_REVIEW_FIRSTNAME
   FASTLANE_REVIEW_LASTNAME
   FASTLANE_REVIEW_PHONE
+  FASTLANE_TEAM_ID
   FASTLANE_USER
+  GITHUB_API_TOKEN
 ]
 # Optional:
 #   FASTLANE_SLACK_URL
@@ -25,11 +27,14 @@ mandatory_environment.each do |var|
   ENV[var] or abort "Missing environment variable: #{var}"
 end
 
-app_identifier(ENV["CI_BUNDLE_ID"] || XcodeFastlane.product_bundle_id)
+ENV["APP_IDENTIFIER"] = ENV["CI_BUNDLE_ID"] || XcodeFastlane.product_bundle_id
 ENV["PRODUCT_NAME"] = ENV["CI_PRODUCT"] || XcodeFastlane.product_name
 ENV["APP_NAME"] = ENV["PRODUCT_NAME"]
 ENV["IOS_IPA_OUTPUT_NAME"] = ENV["PRODUCT_NAME"]
 ENV["IOS_SCHEME"] = ENV["CI_XCODE_SCHEME"] || XcodeFastlane.product_name
+ENV["RELEASE_BRANCH_PREFIX"] = "releases/"
+
+app_identifier(ENV["APP_IDENTIFIER"])
 
 # For more information about the Appfile, see:
 #     https://docs.fastlane.tools/advanced/#appfile

data/templates/fastlane/Deliverfile

@@ -3,5 +3,14 @@
 # The Deliverfile allows you to store various App Store Connect metadata
 # For more information, check out the docs
 # https://docs.fastlane.tools/actions/deliver/
-username(ENV.fetch("FASTLANE_USER", nil))
+app_review_information(
+  first_name: ENV["FASTLANE_REVIEW_FIRSTNAME"],
+  last_name: ENV["FASTLANE_REVIEW_LASTNAME"],
+  phone_number: ENV["FASTLANE_REVIEW_PHONE"],
+  email_address: ENV["FASTLANE_REVIEW_EMAIL"]
+)
+copyright("#{Time.now.year} #{ENV["FASTLANE_REVIEW_FIRSTNAME"]} #{ENV["FASTLANE_REVIEW_LASTNAME"]}")
 languages(%w[en-US de-DE])
+precheck_default_rule_level(:error)
+precheck_include_in_app_purchases(:false)
+username(ENV.fetch("FASTLANE_USER", nil))

metadata

@@ -1,15 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: xcode_fastlane
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Karsten Silkenbäumer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +98,10 @@ files:
 - templates/Gemfile
 - templates/ci_scripts/ci_post_clone.sh
 - templates/ci_scripts/ci_post_xcodebuild.sh
+- templates/fastlane/.env.beta
+- templates/fastlane/.env.ios
+- templates/fastlane/.env.mac
+- templates/fastlane/.env.release
 - templates/fastlane/Appfile
 - templates/fastlane/Deliverfile
 - templates/fastlane/Fastfile