fastlane-plugin-appbox 4.0.0 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -9
  3. data/lib/fastlane/plugin/appbox/actions/appbox_action.rb +7 -9
  4. data/lib/fastlane/plugin/appbox/version.rb +1 -1
  5. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3db84f527f2c015f99d005447b3f209bfca6a1c020ca56fed4a099eb13ceff6e
4
- data.tar.gz: fd340764d6fa68040b93ec7f7b88874850eadc71ae2eb2a67cd0666f620f78f5
3
+ metadata.gz: 985df3a0ef7d9ac530fa7b9446a659cb3fd866005acf71b8dda922e537137629
4
+ data.tar.gz: a22b641a959bdd754262adc06d98cc0bf427e11e2f6656da503a9e78bf03bcab
5
5
  SHA512:
6
- metadata.gz: f1ee9fbc055c6c129638af19988c734229a1bde2b0466e83d230b115d2bf80318e792153eb49cfa8714280765cdaf45a5a1a095d9a66ee8d70909b59cd81f6ba
7
- data.tar.gz: 5729b9846272dc136a5d413195c1d44110f56a779e65355e7f44e5edbb39043107fdb662156317bf5dda83f1b800a327a6c8daadc3bd2b8e67c2a3024dff45d7
6
+ metadata.gz: c68ba482fe892371f11e752da1a571bd08e21547895b1bcbda0d512ddccec83231509c4925669fcffba9cb05b031a07327fd257a6ec24b38c0f2b1594b1ff416
7
+ data.tar.gz: 3dfbbd52d8be06b3ca6a1fc25d0cc7e6912aaa834425380b288db25c10efa1b9a8238c07d88440bd06bde5dc82e8e6b364f2099e99c16025fd657ffcff601fe4
data/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # AppBox Plugin for Fastlane
2
2
 
3
3
  [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-appbox)
4
+ [![Test](https://github.com/getappbox/fastlane-plugin-appbox/actions/workflows/test.yml/badge.svg)](https://github.com/getappbox/fastlane-plugin-appbox/actions/workflows/test.yml)
4
5
 
5
6
  ## 1. Getting Started
6
7
 
@@ -24,16 +25,35 @@ fastlane add_plugin appbox
24
25
 
25
26
  Now, open AppBox and login with your Dropbox account.
26
27
 
28
+ This plugin targets **AppBox 4.0 or later**, which requires macOS 15 Sequoia or later.
29
+
27
30
  **Step 3** - Define appbox action in your project Fastfile with emails and message. Here the available params for appbox plugins -
28
31
 
29
32
  - `emails` (Optional | String) - Comma-separated list of email address that should receive application installation link.
30
- - `message` (Optional | String) - A personal message shown under "Message from the developer" in the email. Sent verbatim — AppBox 4 no longer substitutes `{PROJECT_NAME}` / `{BUILD_VERSION}` / `{BUILD_NUMBER}` placeholders, so build them yourself from fastlane's own variables (see the examples below).
33
+ - `message` (Optional | String) - A personal message shown under "Message from the developer" in the email, such as `'Here is the latest build.'`. Sent exactly as written — see [Using build details in the message](#using-build-details-in-the-message) to include the version or build number, or if you are moving off the AppBox 3 placeholders.
31
34
  - `keep_same_link` (Optional | Bool) - This feature will keep same short URL for all future build/IPA uploaded with same bundle identifier. If this option is enabled, you can also download the previous build with the same URL. Read more [here](https://docs.getappbox.com/Features/keepsamelink/).
32
35
  - `slack_webhook_url` (Optional | String) - Slack Incoming Webhook URL to post a notification to a Slack channel.
33
36
  - `ms_teams_webhook_url` (Optional | String) - Microsoft Teams Incoming Webhook URL to post a notification to a Teams channel.
34
- - `webhook_message` (Optional | String) - **Deprecated and ignored since AppBox 4.** The CLI prints a note and generates the notification text from the build itself. Still accepted so existing Fastfiles keep working.
37
+ - `webhook_message` (Optional | String) - **Deprecated and ignored since AppBox 4**, which generates the notification text from the build itself. The plugin warns and drops it, so existing Fastfiles keep working unchanged.
35
38
  - `dropbox_folder_name` (Optional | String) - You can change the link by providing a Custom Dropbox Folder Name. By default folder name will be the application bundle identifier. So, AppBox will keep the same link for the IPA file available in the same folder. Read more [here](https://docs.getappbox.com/Features/keepsamelink/).
36
39
 
40
+ ### Using build details in the message
41
+
42
+ `message` is plain text and is sent exactly as written, so most Fastfiles just pass a sentence. To include the version, build number or app name, interpolate them from fastlane in a **double-quoted** string, since Ruby only expands `#{}` there:
43
+
44
+ ```rb
45
+ message: "MyApp #{get_version_number}(#{get_build_number}) is ready to test.",
46
+ ```
47
+
48
+ AppBox 3 used to do this for you by substituting `{BUILD_NAME}`, `{BUILD_VERSION}` and `{BUILD_NUMBER}`. AppBox 4 removed that substitution, so a message still containing them arrives with the braces intact. Replace them as follows:
49
+
50
+ | AppBox 3 placeholder | Replace with |
51
+ | --- | --- |
52
+ | `{BUILD_NAME}` | your app or scheme name, or `#{File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa')}` |
53
+ | `{BUILD_VERSION}` | `#{get_version_number}` |
54
+ | `{BUILD_NUMBER}` | `#{get_build_number}` |
55
+ | `{SHARE_URL}` | Nothing to do. It only applied to `webhook_message`, which AppBox 4 ignores and generates itself. |
56
+
37
57
 
38
58
  ## 2. Demo Fastfile with a lane `gymbox` with Different Options
39
59
 
@@ -77,7 +97,7 @@ platform :ios do
77
97
  gym
78
98
  appbox(
79
99
  emails: 'you@example.com',
80
- message: "#{lane_context[SharedValues::IPA_OUTPUT_PATH] ? File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa') : 'Build'} is ready to test.",
100
+ message: 'Please test the new checkout flow.',
81
101
  )
82
102
  end
83
103
  end
@@ -93,7 +113,7 @@ platform :ios do
93
113
  gym
94
114
  appbox(
95
115
  emails: 'you@example.com',
96
- message: "#{lane_context[SharedValues::IPA_OUTPUT_PATH] ? File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa') : 'Build'} is ready to test.",
116
+ message: 'Here is the latest build.',
97
117
  keep_same_link: true,
98
118
  )
99
119
  end
@@ -110,7 +130,7 @@ platform :ios do
110
130
  gym
111
131
  appbox(
112
132
  emails: 'you@example.com',
113
- message: "#{lane_context[SharedValues::IPA_OUTPUT_PATH] ? File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa') : 'Build'} is ready to test.",
133
+ message: 'Here is the latest build.',
114
134
  keep_same_link: true,
115
135
  dropbox_folder_name: 'Fastlane-Demo-Keep-Same-Link',
116
136
  )
@@ -118,10 +138,6 @@ platform :ios do
118
138
  end
119
139
  ```
120
140
 
121
- #### Note
122
- When you run this for the first time, a pop-up will appear stating that "Terminal.app" wants to access data from other apps. You must allow this to copy the IPA file to the Appbox temporary directory, enabling Appbox to access and upload it.
123
- ![](/AppBox-Fastlane-Demo-Project/images/terminal-permission.webp)
124
-
125
141
  ## 3. Supported AppBox link access via Fastlane SharedValues
126
142
  - `APPBOX_SHARE_URL` - AppBox short shareable URL to install uploaded application.
127
143
  - `APPBOX_IPA_URL`- Upload IPA file URL to download IPA file.
data/lib/fastlane/plugin/appbox/actions/appbox_action.rb CHANGED
@@ -13,8 +13,7 @@ module Fastlane
13
13
 
14
14
  class AppboxAction < Action
15
15
  def self.run(params)
16
-
17
- #custom dropbox folder name
16
+ # custom dropbox folder name
18
17
  if params[:dropbox_folder_name]
19
18
  dropbox_folder_name = params[:dropbox_folder_name]
20
19
  UI.message("Dropbox folder name - #{dropbox_folder_name}")
@@ -74,8 +73,7 @@ module Fastlane
74
73
  end
75
74
 
76
75
  if params[:webhook_message]
77
- args += ["--webhookmessage", params[:webhook_message].to_s]
78
- UI.message("Webhook Message - #{params[:webhook_message]}")
76
+ UI.important("webhook_message is deprecated and ignored since AppBox 4 - the notification text is generated from the build.")
79
77
  end
80
78
 
81
79
  UI.message("AppBox Command - #{Shellwords.join(args)}")
@@ -107,7 +105,7 @@ module Fastlane
107
105
  [
108
106
  ['APPBOX_IPA_URL', 'Upload IPA file URL to download IPA file.'],
109
107
  ['APPBOX_MANIFEST_URL', 'Manifest file URL for upload application.'],
110
- ['APPBOX_SHARE_URL', 'AppBox short shareable URL to install uploaded application.'],
108
+ ['APPBOX_SHARE_URL', 'AppBox short shareable URL to install uploaded application.']
111
109
  ]
112
110
  end
113
111
 
@@ -132,7 +130,7 @@ module Fastlane
132
130
 
133
131
  FastlaneCore::ConfigItem.new(key: :message,
134
132
  env_name: "FL_APPBOX_MESSAGE",
135
- description: "A personal message shown under \"Message from the developer\" in the email. Sent verbatim; AppBox 4 does not substitute {BUILD_NAME}/{BUILD_VERSION}/{BUILD_NUMBER} placeholders",
133
+ description: "A personal message shown under \"Message from the developer\" in the email, e.g. 'Here is the latest build.'. Sent exactly as written; AppBox 4 does not substitute the {BUILD_NAME}/{BUILD_VERSION}/{BUILD_NUMBER} placeholders AppBox 3 supported",
136
134
  optional: true),
137
135
 
138
136
  FastlaneCore::ConfigItem.new(key: :keep_same_link,
@@ -159,13 +157,13 @@ module Fastlane
159
157
 
160
158
  FastlaneCore::ConfigItem.new(key: :webhook_message,
161
159
  env_name: "FL_APPBOX_WEBHOOK_MESSAGE",
162
- description: "Deprecated and ignored since AppBox 4 — the notification text is generated from the build. Accepted so existing Fastfiles keep working",
163
- optional: true),
160
+ description: "Deprecated and ignored since AppBox 4, which generates the notification text from the build. Accepted, with a warning, so existing Fastfiles keep working",
161
+ optional: true)
164
162
  ]
165
163
  end
166
164
 
167
165
  def self.is_supported?(platform)
168
- [:ios].include? platform
166
+ [:ios].include?(platform)
169
167
  end
170
168
  end
171
169
  end
data/lib/fastlane/plugin/appbox/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Fastlane
2
2
  module Appbox
3
- VERSION = "4.0.0"
3
+ VERSION = "4.0.1"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,11 +1,11 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fastlane-plugin-appbox
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.0
4
+ version: 4.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vineet Choudhary
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
11
  date: 2026-09-06 00:00:00.000000000 Z
@@ -136,7 +136,7 @@ dependencies:
136
136
  - - ">="
137
137
  - !ruby/object:Gem::Version
138
138
  version: 2.111.0
139
- description:
139
+ description:
140
140
  email: vineetchoudhary@live.in
141
141
  executables: []
142
142
  extensions: []
@@ -152,7 +152,7 @@ homepage: https://github.com/getappbox/fastlane-plugin-appbox
152
152
  licenses:
153
153
  - MIT
154
154
  metadata: {}
155
- post_install_message:
155
+ post_install_message:
156
156
  rdoc_options: []
157
157
  require_paths:
158
158
  - lib
@@ -167,8 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
167
167
  - !ruby/object:Gem::Version
168
168
  version: '0'
169
169
  requirements: []
170
- rubygems_version: 3.5.22
171
- signing_key:
170
+ rubygems_version: 3.0.3.1
171
+ signing_key:
172
172
  specification_version: 4
173
173
  summary: Deploy Development, Ad-Hoc and In-house (Enterprise) iOS applications directly
174
174
  to the devices from your Dropbox account.