fastlane-plugin-codepush 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e26afff641dff17301093b179c51d1252d205cb44f9c2c218e87659635f456b
-  data.tar.gz: d56c46c15d07c8ae3d15112d36168d5c7be9d63e2a760c20a85ccc34b60d13b5
+  metadata.gz: 3fed12971e8dc59e4b6acc0ac861c283c2f85547b13df0b4d321065c394518dc
+  data.tar.gz: 25be99c5ff18dfcd7e7aecc95a16ea4fbd3f17740630d8a3f6d065f7d8525a61
 SHA512:
-  metadata.gz: 8d734f1985bacef4e0c51365145db6dc3c229407580d369aaf5d86a5c03eb4c99213b0f53d665f59ec6cf829b50e6bf33e5aaeddc3ff7682a08a81754168ffec
-  data.tar.gz: 8695e7d7c108c50199337022829b8ee040e7956939dc4f1dca70a299b772cc42ca673374ff94ec8d0f4e97fbd767146c47f376f06c05784d14b6297ed965f953
+  metadata.gz: 18e9807a748792410da69b6d6e2fd40cbb77026c6d14e1316acc87c5dcb9204cd4f83147b257049d7a5b57b7ba719dc06a113d57c97e554abb88f239433dd23e
+  data.tar.gz: 1f117225a521e6c9386ccc2808c3d3ddc17d93a4a9f66d1af5c0b9e053358df53c2bc91fc76961fd5ac41504f1c7a5c3b21f6427a9f753cb2a158fb5c6fcf2ea

data/README.md

@@ -2,6 +2,16 @@
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-codepush)
 
+[📚Documentation](https://pranit-harekar.github.io/fastlane-plugin-codepush)
+
+## Prerequisites
+
+Install the [App Center CLI](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#installation)
+
+```
+npm install -g appcenter-cli
+```
+
 ## Getting Started
 
 This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-codepush`, add it to your project by running:
@@ -24,7 +34,7 @@ This is a Fastlane plugin for App Center CodePush service.
 codepush_login
 ```
 
-| Key         | Description                                                                                         | Environment Variable   | Default |
+| Option      | Description                                                                                         | Environment Variable   | Default |
 | ----------- | --------------------------------------------------------------------------------------------------- | ---------------------- | ------- |
 | login_token | App center login token to access CodePush service, optional if ENV['APP_CENTER_LOGIN_TOKEN'] is set | APP_CENTER_LOGIN_TOKEN |         |
 | enforce     | Enforce logout before login                                                                         |                        | false   |
@@ -50,7 +60,7 @@ codepush_release_react(
 )
 ```
 
-| Action                          | Description                                                                        | Environment Variable | Default |
+| Option                          | Description                                                                        | Environment Variable | Default |
 | ------------------------------- | ---------------------------------------------------------------------------------- | -------------------- | ------- |
 | app_name                        | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set          | APP_CENTER_APP_NAME  |         |
 | execution_dir_path              | Release React CLI command execution dir path                                       |                      | ./      |
@@ -74,7 +84,7 @@ codepush_release_react(
 | bundle_name                     | File name that should be used for the generated JS bundle                          |                      |         |
 | dry_run                         | Print the command that would be run, and don't run it                              |                      | false   |
 
-#### 3. `codepush_promote`
+#### 4. `codepush_promote`
 
 CodePush [promote deployment](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#promoting-updates) action
 
@@ -88,7 +98,7 @@ codepush_promote(
 )
 ```
 
-| Action                          | Description                                                               | Environment Variable | Default |
+| Option                          | Description                                                               | Environment Variable | Default |
 | ------------------------------- | ------------------------------------------------------------------------- | -------------------- | ------- |
 | app_name                        | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
 | execution_dir_path              | Promote CLI command execution dir path                                    |                      | ./      |
@@ -101,6 +111,133 @@ codepush_promote(
 | disable_telemetry               | Specify whether telemetry should be disabled or not                       |                      | false   |
 | dry_run                         | Print the command that would be run, and don't run it                     |                      | false   |
 
+#### 5. `codepush_add_deployment`
+
+CodePush [add deployment](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#deployment-management) action
+
+This action lets you add new CodePush deployment.
+
+```ruby
+codepush_add_deployment(
+  app_name: "pharekar/MyAwesomeApp",
+  deployment_name: "Alpha"
+)
+```
+
+| Option             | Description                                                               | Environment Variable | Default |
+| ------------------ | ------------------------------------------------------------------------- | -------------------- | ------- |
+| app_name           | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
+| execution_dir_path | Release React CLI command execution dir path                              |                      | ./      |
+| deployment_name    | Deployment name                                                           |                      |         |
+| dry_run            | Print the command that would be run, and don't run it                     |                      | false   |
+
+#### 6. `codepush_remove_deployment`
+
+CodePush [remove deployment](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#deployment-management) action
+
+This action lets you remove CodePush deployment.
+
+```ruby
+codepush_remove_deployment(
+  app_name: "pharekar/MyAwesomeApp",
+  deployment_name: "Alpha"
+)
+```
+
+| Option             | Description                                                               | Environment Variable | Default |
+| ------------------ | ------------------------------------------------------------------------- | -------------------- | ------- |
+| app_name           | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
+| execution_dir_path | Release React CLI command execution dir path                              |                      | ./      |
+| deployment_name    | Deployment name                                                           |                      |         |
+| dry_run            | Print the command that would be run, and don't run it                     |                      | false   |
+
+#### 7. `codepush_rename_deployment`
+
+CodePush [rename deployment](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#deployment-management) action
+
+This action lets you rename CodePush deployment.
+
+```ruby
+codepush_rename_deployment(
+  app_name: "pharekar/MyAwesomeApp",
+  deployment_name: "Alpha",
+  new_deployment_name: "Internal-Alpha"
+)
+```
+
+| Option              | Description                                                               | Environment Variable | Default |
+| ------------------- | ------------------------------------------------------------------------- | -------------------- | ------- |
+| app_name            | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
+| execution_dir_path  | Release React CLI command execution dir path                              |                      | ./      |
+| deployment_name     | Deployment name                                                           |                      |         |
+| new_deployment_name | New deployment name                                                       |                      |         |
+| dry_run             | Print the command that would be run, and don't run it                     |                      | false   |
+
+#### 8. `codepush_list_deployment`
+
+CodePush [list deployment](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#deployment-management) action
+
+This action lets you list all CodePush deployment.
+
+```ruby
+codepush_list_deployment(
+  app_name: "pharekar/MyAwesomeApp"
+)
+```
+
+| Option             | Description                                                               | Environment Variable | Default |
+| ------------------ | ------------------------------------------------------------------------- | -------------------- | ------- |
+| app_name           | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
+| execution_dir_path | Release React CLI command execution dir path                              |                      | ./      |
+| dry_run            | Print the command that would be run, and don't run it                     |                      | false   |
+
+#### 9. `codepush_exists_deployment`
+
+This action lets check if given CodePush deployment exists. Returns boolean value.
+
+```ruby
+codepush_exists_deployment(
+  app_name: "pharekar/MyAwesomeApp",
+  deployment_name: "Alpha"
+)
+
+## returns true if 'Alpha' deployment exists otherwise false
+```
+
+| Option             | Description                                                               | Environment Variable | Default |
+| ------------------ | ------------------------------------------------------------------------- | -------------------- | ------- |
+| app_name           | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
+| execution_dir_path | Release React CLI command execution dir path                              |                      | ./      |
+| deployment_name    | Deployment name                                                           |                      |         |
+| dry_run            | Print the command that would be run, and don't run it                     |                      | false   |
+
+#### 10. `codepush_get_deployment_key`
+
+This action returns CodePush deployment key given deployment name. If deployment does not exists it returns `nil`
+
+```ruby
+codepush_get_deployment_key(
+  app_name: "pharekar/MyAwesomeApp",
+  deployment_name: "Alpha"
+)
+
+## 1243453jksau2113l2h1k323h1829ebj
+
+codepush_get_deployment_key(
+  app_name: "pharekar/MyAwesomeApp",
+  deployment_name: "foo"
+)
+
+## nil
+```
+
+| Option             | Description                                                               | Environment Variable | Default |
+| ------------------ | ------------------------------------------------------------------------- | -------------------- | ------- |
+| app_name           | Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set | APP_CENTER_APP_NAME  |         |
+| execution_dir_path | Release React CLI command execution dir path                              |                      | ./      |
+| deployment_name    | Deployment name                                                           |                      |         |
+| dry_run            | Print the command that would be run, and don't run it                     |                      | false   |
+
 ## Example
 
 Check out the [example `Fastfile`](examples/ReactNative/fastlane/Fastfile) to see how to use this plugin.
@@ -134,3 +271,8 @@ For more information about how the `fastlane` plugin system works, check out the
 ## 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).
+
+## Why this plugin?
+
+- [fastlane-plugin-appcenter](https://github.com/microsoft/fastlane-plugin-appcenter) does not support CodePush
+- [Fastfastlane-plugin-code_pushlane](https://github.com/manuelkch/fastlane-plugin-code_push) is outdated & does not support App Center CLI

data/lib/fastlane/plugin/codepush/actions/codepush_add_deployment_action.rb

@@ -0,0 +1,71 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class CodepushAddDeploymentAction < Action
+      def self.run(params)
+        Dir.chdir(params[:execution_dir_path].to_s) do
+          command = "appcenter codepush deployment add "
+          ## params
+          command += "-a #{params[:app_name]} "
+          command += (params[:deployment_name]).to_s
+
+          if params[:dry_run]
+            UI.message('Dry run!'.red + ' Would have run: ' + command + "\n")
+          else
+            sh(command.to_s)
+          end
+        end
+      end
+
+      def self.description
+        'CodePush add deployment action'
+      end
+
+      def self.authors
+        ['Pranit Harekar']
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_name,
+              env_name: "APP_CENTER_APP_NAME",
+              description: "Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set",
+              optional: false,
+              type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :execution_dir_path,
+            description: 'Release React CLI command execution dir path',
+            optional: true,
+            type: String,
+            default_value: "./"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :deployment_name,
+            description: 'Deployment name',
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            description: "Print the command that would be run, and don't run it",
+            is_string: false,
+            default_value: false
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/codepush/actions/codepush_exists_deployment_action copy.rb

@@ -0,0 +1,71 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class CodepushExistsDeploymentAction < Action
+      def self.run(params)
+        Dir.chdir(params[:execution_dir_path].to_s) do
+          command = "appcenter codepush deployment list "
+          ## params
+          command += "-a #{params[:app_name]}"
+
+          if params[:dry_run]
+            UI.message('Dry run!'.red + ' Would have run: ' + command + "\n")
+          else
+            return sh(command.to_s).include?(params[:deployment_name])
+          end
+        end
+      end
+
+      def self.description
+        'CodePush check if deployment exists'
+      end
+
+      def self.authors
+        ['Pranit Harekar']
+      end
+
+      def self.return_value
+        'Returns boolean value indicating whether deployment exists or not'
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_name,
+            env_name: "APP_CENTER_APP_NAME",
+            description: "Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :execution_dir_path,
+            description: 'Release React CLI command execution dir path',
+            optional: true,
+            type: String,
+            default_value: "./"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            description: "Print the command that would be run, and don't run it",
+            is_string: false,
+            default_value: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :deployment_name,
+            description: 'Deployment name',
+            optional: false,
+            type: String
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/codepush/actions/codepush_get_deployment_key_action.rb

@@ -0,0 +1,79 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class CodepushGetDeploymentKeyAction < Action
+      def self.run(params)
+        Dir.chdir(params[:execution_dir_path].to_s) do
+          result = Actions::CodepushExistsDeploymentAction.run(params)
+          if result
+            command = "appcenter codepush deployment list "
+            ## params
+            command += "-a #{params[:app_name]} "
+            command += "--displayKeys "
+            command += "| grep '#{params[:deployment_name]}'"
+
+            if params[:dry_run]
+              UI.message('Dry run!'.red + ' Would have run: ' + command + "\n")
+            else
+              sh(command.to_s)[-50...-13]
+            end
+          else
+            UI.important("🙅‍♀️ Deployment '#{params[:deployment_name]}' does not exists!")
+            return nil
+          end
+        end
+      end
+
+      def self.description
+        'CodePush get deployment key given deployment name'
+      end
+
+      def self.authors
+        ['Pranit Harekar']
+      end
+
+      def self.return_value
+        'Returns deployment key in string format. Returns nil if deployment does not exists'
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_name,
+            env_name: "APP_CENTER_APP_NAME",
+            description: "Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :execution_dir_path,
+            description: 'Release React CLI command execution dir path',
+            optional: true,
+            type: String,
+            default_value: "./"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            description: "Print the command that would be run, and don't run it",
+            is_string: false,
+            default_value: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :deployment_name,
+            description: 'Deployment name',
+            optional: false,
+            type: String
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/codepush/actions/codepush_list_deployment_action.rb

@@ -0,0 +1,64 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class CodepushListDeploymentAction < Action
+      def self.run(params)
+        Dir.chdir(params[:execution_dir_path].to_s) do
+          command = "appcenter codepush deployment list "
+          ## params
+          command += "-a #{params[:app_name]}"
+
+          if params[:dry_run]
+            UI.message('Dry run!'.red + ' Would have run: ' + command + "\n")
+          else
+            sh(command.to_s)
+          end
+        end
+      end
+
+      def self.description
+        'CodePush list deployment action'
+      end
+
+      def self.authors
+        ['Pranit Harekar']
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_name,
+              env_name: "APP_CENTER_APP_NAME",
+              description: "Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set",
+              optional: false,
+              type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :execution_dir_path,
+            description: 'Release React CLI command execution dir path',
+            optional: true,
+            type: String,
+            default_value: "./"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            description: "Print the command that would be run, and don't run it",
+            is_string: false,
+            default_value: false
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/codepush/actions/codepush_remove_deployment_action.rb

@@ -0,0 +1,71 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class CodepushRemoveDeploymentAction < Action
+      def self.run(params)
+        Dir.chdir(params[:execution_dir_path].to_s) do
+          command = "appcenter codepush deployment remove "
+          ## params
+          command += "-a #{params[:app_name]} "
+          command += (params[:deployment_name]).to_s
+
+          if params[:dry_run]
+            UI.message('Dry run!'.red + ' Would have run: ' + command + "\n")
+          else
+            sh(command.to_s)
+          end
+        end
+      end
+
+      def self.description
+        'CodePush remove deployment action'
+      end
+
+      def self.authors
+        ['Pranit Harekar']
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_name,
+              env_name: "APP_CENTER_APP_NAME",
+              description: "Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set",
+              optional: false,
+              type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :execution_dir_path,
+            description: 'Release React CLI command execution dir path',
+            optional: true,
+            type: String,
+            default_value: "./"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :deployment_name,
+            description: 'Deployment name',
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            description: "Print the command that would be run, and don't run it",
+            is_string: false,
+            default_value: false
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/codepush/actions/codepush_rename_deployment_action.rb

@@ -0,0 +1,78 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class CodepushRenameDeploymentAction < Action
+      def self.run(params)
+        Dir.chdir(params[:execution_dir_path].to_s) do
+          command = "appcenter codepush deployment rename "
+          ## params
+          command += "-a #{params[:app_name]} "
+          command += "#{params[:deployment_name]} "
+          command += (params[:new_deployment_name]).to_s
+
+          if params[:dry_run]
+            UI.message('Dry run!'.red + ' Would have run: ' + command + "\n")
+          else
+            sh(command.to_s)
+          end
+        end
+      end
+
+      def self.description
+        'CodePush rename deployment action'
+      end
+
+      def self.authors
+        ['Pranit Harekar']
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_name,
+              env_name: "APP_CENTER_APP_NAME",
+              description: "Name of the App Center app, optional if ENV['APP_CENTER_APP_NAME'] is set",
+              optional: false,
+              type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :execution_dir_path,
+            description: 'Release React CLI command execution dir path',
+            optional: true,
+            type: String,
+            default_value: "./"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :deployment_name,
+            description: 'Deployment name',
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :new_deployment_name,
+            description: 'New deployment name',
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            description: "Print the command that would be run, and don't run it",
+            is_string: false,
+            default_value: false
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Codepush
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-codepush
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pranit Harekar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-01 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -145,10 +145,16 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/codepush.rb
+- lib/fastlane/plugin/codepush/actions/codepush_add_deployment_action.rb
+- lib/fastlane/plugin/codepush/actions/codepush_exists_deployment_action copy.rb
+- lib/fastlane/plugin/codepush/actions/codepush_get_deployment_key_action.rb
+- lib/fastlane/plugin/codepush/actions/codepush_list_deployment_action.rb
 - lib/fastlane/plugin/codepush/actions/codepush_login_action.rb
 - lib/fastlane/plugin/codepush/actions/codepush_logout_action.rb
 - lib/fastlane/plugin/codepush/actions/codepush_promote_action.rb
 - lib/fastlane/plugin/codepush/actions/codepush_release_react_action.rb
+- lib/fastlane/plugin/codepush/actions/codepush_remove_deployment_action.rb
+- lib/fastlane/plugin/codepush/actions/codepush_rename_deployment_action.rb
 - lib/fastlane/plugin/codepush/helper/codepush_login_helper.rb
 - lib/fastlane/plugin/codepush/version.rb
 homepage: https://github.com/Pranit-Harekar/fastlane-plugin-codepush