appship 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 512f49f01b45fb318992c5dff4df86626d61aea2c57818556763fc869ecee047
-  data.tar.gz: 949c652229a3c30bf38d1e0727fb30be191b93e9198da561a7648592a0ca2687
+  metadata.gz: 905aafaf87595c7b9f88071620d883fe4d15e513fc297d55208e88d3fe9fc263
+  data.tar.gz: 10b04c144cb0de4c4db92373d4b4b7e5fbc9fc8d25af4c5de2e6e9eb8c9db051
 SHA512:
-  metadata.gz: 4884ca69b0efaf1ab59bd0ecd660d755b93c762545b578b6e30547c613d77ee8e65972efa6783aca244c27951980b45506f09cb4005bf27f2f5fa4905220521e
-  data.tar.gz: 7a108e44ed054b191a7d6dd5f78316a2cccc49b2298a6f18135d408aecf87e2c8370480ad640c3a1baa6bc2cbbad406f327c1a8b3c34705794838a6717902533
+  metadata.gz: 5f362de8ab1337aa62297ddd595c8912dba9b78fd8fa0fec15d2f22a4b8fbefade601bee257155a31a517a404a85789946785a2dd1b89255ad9f191cb8972eb4
+  data.tar.gz: 0f44e337fb7f5ac586e506d55a1ac1360b91ccf999f5a5551be781706537fb29e8956f6ceb53bb40e8552ce613dcfea5f8e5004513de453f7a53375bea3adc05

data/README.md

@@ -4,7 +4,7 @@ Appship 是一款面向 iOS 开发者的命令行自动化工具，旨在简化
 
 它支持自动构建和导出 IPA，并将应用上传至蒲公英（Pgyer）或 fir.im，同时提供 API Key、访问密码和项目配置管理。上传完成后，终端会输出应用版本、密码状态及下载链接，方便团队快速进行测试和分发。
 
-### 构建耗时对比
+### 构建耗时对比（构建机器： Apple M4 16gb）
 
 ```mermaid
 gantt
@@ -20,12 +20,15 @@ gantt
 
 ## 安装
 
-```
-gem install appship
+macOS 默认的 zsh 终端只需执行以下两条命令：
 
-export PATH="$(ruby -e 'print Gem.user_dir')/bin:$PATH"
+```bash
+gem install appship
+echo 'export PATH="$(ruby -rrubygems -e "print Gem.bindir"):$PATH"' >> ~/.zshrc && source ~/.zshrc
 ```
 
+第二条命令只需执行一次：将 gem 的命令目录写入 `~/.zshrc`，并立即加载。以后重新打开终端，即可直接执行 `appship pgyer` 或 `appship fir`。
+
 ### 环境依赖
 
 如果需要图标角标，还需要 ImageMagick：
@@ -50,25 +53,168 @@ appship pgyer
 appship fir
 ```
 
+按终端提示，配置构建信息
+
 等待片刻...
 
-```
-=======================================================
-                   🎉 发布完成 🎉
-=======================================================
-分发平台: fir.im
+发布成功后，终端会输出发布消息(默认模板格式)：
+
+```text
 应用名称: Demo
 应用类型: iOS
 版本信息: 1.0.0(42)
+构建模式: Release
+应用大小: 167.8MB
+更新时间: 2026-11-04 16:52:16
 更新描述: xxx
-访问密码: xxx
-下载链接: https://fir.im/abc123
-=======================================================
+安装密码: xxx
+下载链接: https://www.pgyer.com/xxxx
+```
+
+## 高阶用法
+
+在包含 `.xcodeproj` 的工程根目录执行：
+
+```bash
+appship init
+```
+
+生成与 `.xcodeproj` 同级的目录和两个示例文件（已有文件不会覆盖）：
+
+```text
+Demo.xcodeproj/
+appship/
+  config.yml.sample
+  message.yml.sample
+```
+
+示例文件不会参与运行。按需复制，去掉 `.sample` 后编辑：
+
+```bash
+cp -n appship/config.yml.sample appship/config.yml
+cp -n appship/message.yml.sample appship/message.yml
+```
+
+`config.yml.sample` 从 `.xcodeproj` 识别 `project_name`，并用注释列出蒲公英、fir.im 和两个机器人的配置字段，不复制全局密钥。生效的 `appship/config.yml` 是 YAML，可只填需要覆盖的字段。例如：
+
+```yaml
+project_name: Demo
+app_name: DemoApp
+pgyer_password: ""
+wechat_webhook: ""
+...
 ```
 
-## 其他用法
+参数优先级为：命令行参数 → 项目 `appship/config.yml` → `~/.appship/.config` 中同名项目 → 默认值。缺少的字段按字段补齐，不会使用其他项目的配置；项目配置中的空字符串也是明确的值，例如空密码表示不设密码，空 Webhook 表示关闭通知。想继承全局值时，应省略该字段，而非填空字符串。
+
+### App Icon 角标
+
+在 `appship/config.yml` 中可按需设置：
+
+```yaml
+app_icon_badge: true
+app_icon_badge_environment: true
+app_icon_badge_version: false  # 预留，目前不绘制版本号
+```
+
+`app_icon_badge: false` 关闭所有角标；启用时默认显示 `DEBUG` 或 `RELEASE`，缓存模式以实际找到的包为准。
+`app_icon_badge_environment: false` 只关闭自动环境文字；已有的自定义 `badge` 仍可用。
+两个开关都不填时，保留原来的选择和默认行为。
+
+## 自定义发布消息
+
+直接编辑项目下的 `appship/message.yml`，目前支持企微、钉钉、飞书机器人通知，配置多个则会发多条消息通知，格式配置如下：
+
+```yaml
+cli_content: |
+  应用名称：%{name}
+  版本：%{version_info}
+  下载：%{url}
+wechat_webhook_success_content: |
+  **%{name} 发布成功**
+  [下载应用](%{url})
+wechat_webhook_format: markdown
+wechat_webhook_failure_content: |
+  ❌ %{name} 发布失败（%{configuration}）
+  原因：%{error_message}
+dingtalk_webhook_success_content: ""
+dingtalk_webhook_failure_content: ""
+feishu_webhook_success_content: |
+  %{name} 发布成功
+  下载：%{url}
+feishu_webhook_failure_content: ""
+feishu_webhook_format: post
+```
+
+#### message.yml可读参数如下：
+
+###### 发布成功
+
+```
+name            : 应用名称 
+build_type_name : 应用类型，例如 iOS、Android 
+version_info    : 版本信息，例如 1.0.0(42) 
+configuration   : 构建配置，例如 Debug、Release 
+build_size_mb   : 应用大小，例如 39.5MB 
+build_updated   : 更新时间 
+description     : 本次更新内容 
+password        : 安装密码或密码设置状态 
+url             : 应用下载链接
+```
+
+###### 失败
+
+以下变量用于各机器人的 `*_webhook_failure_content`，在文案中写成 `%{变量名}`。
+
+```text
+name          : 应用名称，缺失时使用工程名；两者都未取得时显示「未知」
+provider      : 分发平台，例如「蒲公英」或「fir.im」
+configuration : 构建配置，例如 Debug、Release；未取得时显示「未选择」
+error_type    : 异常类型，例如 Appship::CommandError
+error_message : 具体错误说明，例如「归档失败」或「上传失败」
+```
+
+例如，在 `appship/message.yml` 中自定义飞书失败文案：
+
+```yaml
+feishu_webhook_failure_content: |
+  ❌ %{name} 发布失败（%{provider} / %{configuration}）
+  错误类型：%{error_type}
+  失败原因：%{error_message}
+```
+
+失败文案不填写或无效时使用内置文案。失败通知以纯文本发送，发送前会隐藏已知的 API Key、密码、Webhook 地址和 URL 查询参数。
+
+[企微 Markdown 配置](https://cloud.tencent.com/document/product/248/50413)
+[飞书自定义机器人](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot)
+[钉钉群自定义机器人说明](https://open-dingtalk.github.io/developerpedia/docs/learn/bot/webhook/overview/)
+
+钉钉存量自定义机器人需配置匹配消息内容的关键词或出口 IP 白名单；Appship 不支持钉钉加签。Webhook 地址不会回显到终端，配置文件权限保持为 `0600`。
+接口参考：
+[企业微信文本消息示例](https://cloud.tencent.com/document/product/1831/134518)
+[钉钉机器人安全设置](https://open.dingtalk.com/document/robots/customize-robot-security-settings)
+
+## 本地配置命令
+
+#### 通知机器人
+
+`wechat_webhook`（企业微信）、`dingtalk_webhook`（钉钉）和 `feishu_webhook`（飞书）都是可选字段，不填写或留空时不发送通知。在项目目录执行以下命令保存地址；URL 需要用引号包裹：
+
+```bash
+appship webhook wechat "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx"
+appship webhook dingtalk "https://oapi.dingtalk.com/robot/send?access_token=xxx"
+appship webhook feishu "https://open.feishu.cn/open-apis/bot/v2/hook/xxx"
+```
+
+#### 关闭某个平台的通知：
+
+```bash
+appship webhook wechat ""
+appship webhook dingtalk ""
+appship webhook feishu ""
+```
 
-更换安装密码
+#### 更换安装密码
 
 ```
 appship pgyer -password xxx
@@ -76,7 +222,7 @@ appship pgyer -password xxx
 appship fir -password xxx
 ```
 
-更换上传秘钥
+#### 更换上传秘钥
 
 ```
 appship pgyer -key xxx
@@ -87,8 +233,8 @@ appship fir -key xxx
 ## 待办
 
 ```
-1、补充消息机器人
-2、自定义消息格式
-3、其他分发平台
+1、其他分发平台
+2、AI 接入git log ，自动归纳更新描述
+3、优化命令
 ...
 ```

data/lib/appship/builder.rb

@@ -9,6 +9,7 @@ module Appship
     end
 
     def build!(options)
+      templates = Message.templates if options[:upload]
       target = target_options(options)
       scheme = required!(options[:scheme], "--scheme 或配置 scheme")
       configuration = options[:configuration] || "Debug"
@@ -58,7 +59,7 @@ module Appship
         end
         puts "✅ IPA 已生成: #{output}"
 
-        upload_if_requested!(output, options)
+        upload_if_requested!(output, options, templates)
         output
       ensure
         FileUtils.rm_rf(temp_root) if temp_root && !options[:keep_temporary]
@@ -99,6 +100,7 @@ module Appship
     end
 
     def package!(options)
+      templates = Message.templates if options[:upload]
       app = File.expand_path(required!(options[:app], "--app"))
       raise ConfigurationError, ".app 不存在: #{app}" unless File.directory?(app)
 
@@ -107,17 +109,16 @@ module Appship
       runner.require_command!("unzip", "macOS 通常自带 unzip") if options[:badge]
       Ipa.package!(app, output: output, badge: options[:badge], assets: options[:assets], app_icon: options[:app_icon], runner: runner)
       puts "✅ IPA 已生成: #{output}"
-      upload_if_requested!(output, options)
+      upload_if_requested!(output, options, templates)
       output
     end
 
     def upload!(options)
+      templates = Message.templates
       file = File.expand_path(required!(options[:file], "IPA 文件路径"))
       raise ConfigurationError, "文件不存在: #{file}" unless File.file?(file)
 
-      result = Uploader.new(options).upload!(file)
-      Display.upload_result(result, file: file, options: options)
-      result
+      upload_file!(file, options, templates)
     end
 
     private
@@ -191,11 +192,17 @@ module Appship
       PLIST
     end
 
-    def upload_if_requested!(file, options)
+    def upload_if_requested!(file, options, templates = nil)
       return unless options[:upload]
 
+      upload_file!(file, options, templates || Message.templates)
+    end
+
+    def upload_file!(file, options, templates)
       result = Uploader.new(options).upload!(file)
-      Display.upload_result(result, file: file, options: options)
+      messages = Display.upload_result(result, file: file, options: options, templates: templates)
+      Webhook.new(options).notify(messages, formats: templates.slice(*Message::FORMATS.keys))
+      result
     end
 
     def required!(value, name)
@@ -212,12 +219,18 @@ module Appship
   module Display
     module_function
 
-    def upload_result(result, file:, options: {})
-      if result.is_a?(Hash) && result["provider"] == "fir"
-        fir_upload_result(result, file: file, options: options)
-        return
-      end
+    def upload_result(result, file:, options: {}, templates: Message.templates)
+      values = if result.is_a?(Hash) && result["provider"] == "fir"
+                 fir_message_values(result, file: file, options: options)
+               else
+                 pgyer_message_values(result, file: file, options: options)
+               end
+      messages = templates.slice(*Message::CONTENT_FIELDS).transform_values { |body| Message.render_text(body, values) }
+      puts messages.fetch("cli_content")
+      messages
+    end
 
+    def pgyer_message_values(result, file:, options:)
       data = result.is_a?(Hash) ? (result["data"] || result) : {}
       key = deep_find(data, "buildKey")
       name = deep_find(data, "buildName") || options[:app_name] || File.basename(file, File.extname(file))
@@ -240,23 +253,20 @@ module Appship
       password ||= "未设置"
       url = key ? "https://www.pgyer.com/#{key}" : "https://www.pgyer.com/"
 
-      puts ""
-      puts "======================================================="
-      puts "                   🎉 发布完成 🎉                      "
-      puts "======================================================="
-      puts "应用名称: #{name}"
-      puts "应用类型: #{build_type_name}"
-      puts "版本信息: #{version_info}" if version_info
-      puts "构建模式: #{configuration}"
-      puts "应用大小: #{build_size_mb}" if build_size_mb
-      puts "更新时间: #{build_updated}" if build_updated && !build_updated.to_s.empty?
-      puts "更新描述: #{description}"
-      puts "安装密码: #{password}"
-      puts "下载链接: #{url}"
-      puts "======================================================="
+      {
+        name: name,
+        build_type_name: build_type_name,
+        version_info: version_info,
+        configuration: configuration,
+        build_size_mb: build_size_mb,
+        build_updated: build_updated.to_s.empty? ? nil : build_updated,
+        description: description,
+        password: password,
+        url: url
+      }
     end
 
-    def fir_upload_result(result, file:, options: {})
+    def fir_message_values(result, file:, options:)
       data = result["data"].is_a?(Hash) ? result["data"] : result
       name = data["name"] || options[:app_name] || File.basename(file, File.extname(file))
       type = data["type"].to_s == "android" ? "Android" : "iOS"
@@ -266,18 +276,17 @@ module Appship
                        build && !build.to_s.empty? ? "#{version}(#{build})" : version.to_s
                      end
 
-      puts ""
-      puts "======================================================="
-      puts "                   🎉 发布完成 🎉                      "
-      puts "======================================================="
-      puts "分发平台: fir.im"
-      puts "应用名称: #{name}"
-      puts "应用类型: #{type}"
-      puts "版本信息: #{version_info}" if version_info
-      puts "更新描述: #{options[:description] || ""}"
-      puts "访问密码: #{data["password_protected"] ? "已设置" : "未设置"}"
-      puts "下载链接: #{result["url"]}"
-      puts "======================================================="
+      {
+        name: name,
+        build_type_name: type,
+        version_info: version_info,
+        configuration: nil,
+        build_size_mb: nil,
+        build_updated: nil,
+        description: options[:description] || "",
+        password: data["password_protected"] ? "已设置" : "未设置",
+        url: result["url"] || ""
+      }
     end
 
     def deep_find(value, wanted_key)

data/lib/appship/cache.rb

@@ -30,7 +30,11 @@ module Appship
         raise ConfigurationError, missing_credentials_message(expanded, provider, empty: true)
       end
 
-      new(expanded)
+      cache = new(expanded)
+      return cache unless cache.entries.empty?
+      return collect_interactively!(expanded, project_dir: project_dir, provider: provider) if interactive && $stdin.tty?
+
+      raise ConfigurationError, missing_credentials_message(expanded, provider, empty: true)
     end
 
     def self.create_file!(path)
@@ -41,24 +45,29 @@ module Appship
       path
     end
 
-    def self.collect_interactively!(path, project_dir: Dir.pwd, provider: "pgyer")
-      project_name = infer_project_name!(project_dir)
+    def self.collect_interactively!(path, project_dir: Dir.pwd, provider: "pgyer", entries: [], project_name: nil, credential_overrides: {})
+      project_name ||= infer_project_name!(project_dir)
+      unless [".xcodeproj", ".xcworkspace"].any? { |extension| File.directory?(File.join(project_dir, "#{project_name}#{extension}")) }
+        raise ConfigurationError, "当前目录找不到 #{project_name}.xcodeproj 或 #{project_name}.xcworkspace，无法新增项目配置: #{File.expand_path(project_dir)}"
+      end
       provider_name = provider.to_s == "fir" ? "fir.im" : "pgyer"
       credential_key = credential_key_for(provider)
       puts ""
-      puts "首次使用 appship #{provider_name}，请填写本机项目缓存。"
+      puts "首次使用当前项目的 appship #{provider_name}，请填写本机项目缓存。"
       puts "缓存文件: #{path}"
       puts ""
-      puts "✅ 已从 #{File.basename(project_name)}.xcodeproj 识别 project_name: #{project_name}"
+      puts "✅ 已识别 project_name: #{project_name}"
       app_name = prompt_required("app_name")
       data = {
         "project_name" => project_name,
         "app_name" => app_name,
-        credential_key => prompt_required(credential_key)
+        "wechat_webhook" => "",
+        "dingtalk_webhook" => "",
+        credential_key => credential_overrides[credential_key] || prompt_required(credential_key)
       }
       password_key = provider.to_s == "fir" ? "fir_password" : "pgyer_password"
-      data[password_key] = prompt_optional(password_key)
-      File.write(path, JSON.pretty_generate([data]) + "\n")
+      data[password_key] = credential_overrides.fetch(password_key) { prompt_optional(password_key) }
+      File.write(path, JSON.pretty_generate(entries + [data]) + "\n")
       File.chmod(0o600, path)
       puts ""
       puts "✅ 本机缓存已保存: #{path}"
@@ -88,7 +97,10 @@ module Appship
 
     def self.prompt_optional(name)
       print "请输入 #{name}（可为空，直接回车表示不设置密码）: "
-      $stdin.gets.to_s.strip
+      value = $stdin.gets
+      raise ConfigurationError, "配置输入已中断，请重新执行命令继续填写" unless value
+
+      value.strip
     end
 
     def initialize(path = DEFAULT_PATH)
@@ -98,31 +110,55 @@ module Appship
       @entries = parse(File.read(@path))
       raise ConfigurationError, "缓存文件必须是字典数组: #{@path}" unless @entries.is_a?(Array)
       @entries = @entries.map { |entry| normalize(entry) }
-      raise ConfigurationError, "缓存文件中没有有效项目: #{@path}" if @entries.empty?
     rescue Psych::SyntaxError => e
       raise ConfigurationError, "缓存文件解析失败: #{e.message}"
     end
 
-    def resolve(project_name: nil, project_dir: Dir.pwd, provider: "pgyer", interactive: true, credential_overrides: {})
-      candidate_name = project_name.to_s.strip
-      if candidate_name.empty? && @entries.length > 1
-        directory_name = File.basename(File.expand_path(project_dir))
-        candidate_name = directory_name if @entries.any? { |entry| entry["project_name"] == directory_name }
+    def resolve(project_name: nil, project_dir: Dir.pwd, provider: "pgyer", interactive: true, credential_overrides: {}, credentials: true)
+      candidate_names = [project_name.to_s.strip].reject(&:empty?)
+      if candidate_names.empty?
+        directory = File.expand_path(project_dir)
+        candidate_names = Dir[File.join(directory, "*.xcodeproj"), File.join(directory, "*.xcworkspace")]
+                          .select { |path| File.directory?(path) }
+                          .map { |path| File.basename(path, File.extname(path)) }.uniq
+        if candidate_names.empty? && @entries.length > 1
+          directory_name = File.basename(directory)
+          candidate_names = [directory_name] if @entries.any? { |entry| entry["project_name"] == directory_name }
+        end
       end
 
-      matches = if candidate_name.empty?
+      matches = if candidate_names.empty?
                   @entries
                 else
-                  @entries.select { |entry| entry["project_name"] == candidate_name }
+                  @entries.select { |entry| candidate_names.include?(entry["project_name"]) }
       end
       if matches.length == 1
         update_profile!(matches.first, credential_overrides) unless credential_overrides.empty?
-        ensure_provider_credential!(matches.first, provider, interactive: interactive)
+        ensure_provider_credential!(matches.first, provider, interactive: interactive) if credentials
         return matches.first
       end
       if matches.empty?
+        if interactive && $stdin.tty?
+          puts "ℹ️ 当前项目没有匹配的 project_name，将引导新增项目配置。"
+          cache = self.class.collect_interactively!(
+            @path,
+            project_dir: project_dir,
+            provider: provider,
+            entries: @entries,
+            project_name: candidate_names.one? ? candidate_names.first : nil,
+            credential_overrides: credential_overrides
+          )
+          @entries = cache.entries
+          return @entries.last
+        end
+
         available = @entries.filter_map { |entry| entry["project_name"] }.join(", ")
-        raise ConfigurationError, "找不到项目缓存 #{candidate_name.inspect}，可用项目: #{available}"
+        key = self.class.send(:credential_key_for, provider)
+        raise ConfigurationError, "当前项目没有匹配的 project_name: #{candidate_names.join(", ")}\n" \
+                                  "请在 #{@path} 的配置数组中增加当前项目配置，保留已有项目。\n" \
+                                  "project_name 应填写: #{candidate_names.join(" 或 ")}（不含 .xcodeproj/.xcworkspace 后缀）\n" \
+                                  "同时填写 app_name、#{key}；安装密码可为空。\n" \
+                                  "已有项目: #{available}"
       end
 
       names = matches.filter_map { |entry| entry["project_name"] }.join(", ")