fastlane-plugin-setapp 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee8f1ec606090dda29299f0dc1439db3bfd92869d8dfe50fb8597cf9022334bd
-  data.tar.gz: 1db7583c07f4352f62bbc0699f0699228d678ad225edc38379fd1ca32afc1715
+  metadata.gz: 72b75b5b716e6794fa7c41084e4e6007051009f5543e610c8ded30b751064520
+  data.tar.gz: 19b140655decdbf092b19195804fb4ec26038c6b99d9df015391373e93e7d837
 SHA512:
-  metadata.gz: 5b7160e1fcd264124de622b04adeb823a9310de1656082d2b4150fae5bcaf9965c3033f6dc1f56e4205b6c58961ac4751690905acad5f84132b15ce0d0282e44
-  data.tar.gz: 530e37e665581cde0d4c15eaece9c49882ea0bae9dde46427d764b9b129e32737eb3fd9206ce45eb2d643f18c5b6a1797767eccc13efcbf51cf4e7624d19ca69
+  metadata.gz: 48a06c152d5e0b80988112027359e627efda2606aee861cd30f7ddab84c5ef996c726a46689e36ae64054f82b1c41f391cf8e3c93121d9a95d21fffa04ae14d7
+  data.tar.gz: 974f5271ad85c5efba2a3c5b56dc3f879842f6cbe472cc870ecd689bda8a216c3b2870dc0ba425330c0e10713ffce3a141815583cf5bcd59b8542c46b5580c6c

data/README.md

@@ -46,12 +46,13 @@ Uploads new version to Setapp and save it as a draft or send to a review process
 
 ```ruby
 upload_setapp_build(
-  api_token: '...', # Your Setapp API token
+  automation_token: '...', # Your Setapp Automation token
   build_path: '...', # The path to archive with a new Setapp build
   release_notes: '...', # Text or path to a file that contains release notes for a new version
   version_status: 'review', # Version status. It can be `draft` or `review`
   release_on_approval: true, # Indicates whether Setapp must publish a new version after review
-  is_beta: false # Is beta or stable build
+  is_beta: false, # Is beta or stable build
+  allow_overwrite: true # Allow to overwrite existing version
 )
 ```
 

data/lib/fastlane/plugin/setapp/actions/upload_setapp_build.rb

@@ -5,24 +5,26 @@ module Fastlane
   module Actions
     class UploadSetappBuildAction < Action
       def self.run(params)
-        api_token = params[:api_token]
+        automation_token = params[:automation_token]
         build_path = params[:build_path]
         release_notes = params[:release_notes]
         version_status = params[:version_status]
         release_on_approval = params[:release_on_approval] ? "true" : "false"
         is_beta = params[:is_beta] ? "true" : "false"
+        allow_overwrite = params[:allow_overwrite] ? "true" : "false"
         file_dir = File.dirname(__FILE__)
         UI.user_error!("Available options for version_status: [draft, review].") unless ['draft', 'review'].include?(version_status)
         UI.message("The build at path #{build_path} will be uploaded to Setapp")
         script_path = "#{file_dir}/../helper/setapp_build_uploader.sh"
         exit_code = system(
           "bash", script_path,
-          "--token", api_token,
+          "--token", automation_token,
           "--path", build_path,
           "--notes", release_notes,
           "--status", version_status,
           "--release-on-approval", release_on_approval,
-          "--beta", is_beta
+          "--beta", is_beta,
+          "--allow-overwrite", allow_overwrite
         )
         UI.user_error!("Uploading error occured. Try again.") if exit_code != true
       end
@@ -49,9 +51,9 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
-            key: :api_token,
-            env_name: "SETAPP_API_TOKEN",
-            description: "Your Setapp API token",
+            key: :automation_token,
+            env_name: "SETAPP_AUTOMATION_TOKEN",
+            description: "Your Setapp Automation token",
             optional: false,
             sensitive: true,
             type: String
@@ -91,6 +93,14 @@ module Fastlane
             optional: false,
             default_value: false,
             type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :allow_overwrite,
+            env_name: "SETAPP_ALLOW_OVERWRITE",
+            description: "Can overwrite existing version or not. Applies to all statuses except `Approved`. Available options: `true`, `false`",
+            optional: false,
+            default_value: false,
+            type: Boolean
           )
         ]
       end

data/lib/fastlane/plugin/setapp/helper/setapp_build_uploader.sh

@@ -18,12 +18,12 @@ function help() {
 
     OPTIONS
         -t, --token
-            Your Setapp token for continious integration. 
+            Your Setapp Automation token for continious integration. 
 
         -p, --path
             Path to an archive with a new bundle version.
 
-        -n, -notes
+        -n, --notes
             Release notes for a new version. Add them as a plain text or as a path to file with text.
 
         -s, --status
@@ -38,6 +38,10 @@ function help() {
         -b | --beta
             Is beta or stable build.
             Available options: (true/false)
+        
+        -a | --allow-overwrite
+            Can ovewrite existing version, including release notes and archive. 
+            Available options: (true/false)
 
         -h, --help
             Usage help
@@ -57,7 +61,7 @@ function parse_params() {
                 ;;
             -t | --token)
                 if test $# -gt 0; then
-                    api_token="${1}"
+                    automation_token="${1}"
                 fi
                 shift;;
             -p | --path)
@@ -88,6 +92,11 @@ function parse_params() {
                     beta="${1}"
                 fi
                 shift;;
+            -a| --allow-overwrite)
+                if test $# -gt 0; then
+                    allow_overwrite="${1}"
+                fi
+                shift;;
             *)
                 die "Invalid parameter was provided: $param" 1
                 ;;
@@ -96,12 +105,13 @@ function parse_params() {
 }
 
 function check_parameters() {
-    [[ -z "${api_token}" ]] && die "Missing required parameter: api-token"
-    [[ -z "${archive_path}" ]] && die "Missing required parameter: archive-path"
-    [[ -z "${release_notes}" ]] && die "Missing required parameter: release-notes"
-    [[ -z "${version_status}" ]] && die "Missing required parameter: version-status"
+    [[ -z "${automation_token}" ]] && die "Missing required parameter: token"
+    [[ -z "${archive_path}" ]] && die "Missing required parameter: path"
+    [[ -z "${release_notes}" ]] && die "Missing required parameter: notes"
+    [[ -z "${version_status}" ]] && die "Missing required parameter: status"
     [[ -z "${release_on_approval}" ]] && die "Missing required parameter: release-on-approval"
     [[ -z "${beta}" ]] && die "Missing required parameter: beta"
+    [[ -z "${allow_overwrite}" ]] && die "Missing required parameter: allow-ovewrite"
 }
 
 function validate_server_response() {
@@ -112,7 +122,7 @@ function validate_server_response() {
     if [ "$response_code" -ge 200 ] && [ "$response_code" -lt 300 ]; then
         echo "✅ The app version is uploaded. All checks are passed."
     elif [ $response_code -eq 401 ]; then
-        die "⚠️ Something went wrong with your API token.\n${response_body}"
+        die "⚠️ Something went wrong with your Setapp Automation token.\n${response_body}"
     elif [ $response_code -eq 400 ]; then
         die "🚨 Bundle validation error occured. See details in description below.\n${response_body}"
     else 
@@ -120,17 +130,18 @@ function validate_server_response() {
     fi
 }
 
-function upload_binary() {
+function create_or_overwrite_existing_app_version() {
     response=$(
         curl -X POST "https://developer-api.setapp.com/v1/ci/version" \
         --write-out "HTTPSTATUS:%{http_code}" \
-        -H "Authorization: Bearer ${api_token}" \
+        -H "Authorization: Bearer ${automation_token}" \
         -H "accept: application/json" \
         -H "Content-Type: multipart/form-data" \
         -F "release_notes=${release_notes}" \
         -F "status=${version_status}" \
         -F "release_on_approval=${release_on_approval}" \
         -F "beta=${beta}" \
+        -F "allow_overwrite=${allow_overwrite}" \
         -F "archive=@${archive_path};type=application/zip"
     )
     validate_server_response "${response}"
@@ -139,7 +150,7 @@ function upload_binary() {
 function main() {
     parse_params "$@"
     check_parameters
-    upload_binary
+    create_or_overwrite_existing_app_version
 }
 
 main "$@"

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Setapp
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-setapp
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Setapp Limited
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler