fastlane-plugin-github_status 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c63210bd71ce1329379c0a2c407cb7eedd50b5a
-  data.tar.gz: 43b0022b168f882f9e3215f39df7f0f58200aa5c
+  metadata.gz: d590ee426df3c9db50f0c1145891c3af01fe5862
+  data.tar.gz: 13759d5e23f9abc36a533144889d6d9b21798025
 SHA512:
-  metadata.gz: 10537b24a43898835f9f4e5efaab406a33429be0a9fcd8b1838322573b4f15d58022277714e42da3a1e38a4e385ee550ed50876ab9366297a376b190a808b6a4
-  data.tar.gz: 5649d201f794cd449c6c1288f18ef8b1752f7aef241790785d0f9c99a95d030a26cef510ee2db749c69b23e5b075a4766c36ff838eeff2c6db5aa663e56c8395
+  metadata.gz: be1ad13915e6c6b296e5b13cd22a1455561d0fe043f46254f7bf7387c7df399f711b74b5a97f507ec09855f12d5fa375780d562e40f312fe6d2bbb23408ece82
+  data.tar.gz: 03e59a44d8e3ef7485ce76e9e3e715f9bdec4801a9682ab1614bb60ce7092c3fa3f5778ecd08b1b47b6f1ae48c068ea3b31e190c56a9e62cb9a74dd8b5caf9a9

data/README.md

@@ -12,16 +12,44 @@ fastlane add_plugin github_status
 
 ## About github_status
 
-Provides the ability to check on GitHub server status as part of your build
+Provides the ability to display and act upon GitHub server status as part of your build
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+#### Status display
+
+```ruby
+	# Display the status of the GitHub APIs as part of your build
+	github_status
+```
+
+![example output](assets/example_output.png)
+
+#### Stop your build preemptively
+
+If you use GitHub as part of your build and release process, it can be important to know that their APIs are having trouble before you start taking release actions.
+
+```ruby
+	# Stop the build if the status of the GitHub APIs is currently at or above a certain level of trouble
+	github_status(abort_level: 'major') # 'minor' or 'major'
+```
+
+If you want to see how your build will behave when GitHub returns a particular status, you can temporarily force the plugin to return a particular status value by setting the `GITHUB_STATUS_TEST_STATUS` environment variable before your run, like:
+
+```bash
+GITHUB_STATUS_TEST_STATUS=major fastlane your_lane
+```
+
+#### Retrieve the status for your own use
+
+```ruby
+	# Capture the GitHub APIs status information, and use it however you'd like
+	message = github_status
+	puts "✅ #{message.body} ✅" if message.status == 'good'
+```
 
 ## Example
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
-
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/github_status.rb

@@ -7,6 +7,7 @@ require 'fastlane/plugin/github_status/version'
 require 'fastlane/plugin/github_status/ui'
 require 'fastlane/plugin/github_status/message'
 require 'fastlane/plugin/github_status/client'
+require 'fastlane/plugin/github_status/options'
 
 module Fastlane
   module GithubStatus

data/lib/fastlane/plugin/github_status/actions/github_status_action.rb

@@ -2,7 +2,14 @@ module Fastlane
   module Actions
     class GithubStatusAction < Action
       def self.run(params)
-        ui.print_message(client.last_message)
+        message = client.last_message
+        ui.print_message(message)
+
+        if message.status_at_least?(params[:abort_level])
+          ui.abort!("Aborting because of GitHub status: #{ui.status_statement(message)}")
+        end
+
+        message
       end
 
       def self.description
@@ -14,13 +21,7 @@ module Fastlane
       end
 
       def self.available_options
-        [
-          # FastlaneCore::ConfigItem.new(key: :your_option,
-          #                         env_name: "GITHUB_STATUS_YOUR_OPTION",
-          #                      description: "A description of your option",
-          #                         optional: false,
-          #                             type: String)
-        ]
+        Plugin::GitHubStatus::Options.available_options
       end
 
       def self.is_supported?(platform)
@@ -31,20 +32,15 @@ module Fastlane
       # collaborators
       #
 
-      # Used to override the UI for testing
-      def self.ui=(ui)
-        @ui = ui
+      class << self
+        attr_accessor :ui
+        attr_accessor :client
       end
 
       def self.ui
         @ui ||= Plugin::GitHubStatus::UI.new
       end
 
-      # Used to override the Client for testing
-      def self.client=(client)
-        @client = client
-      end
-
       def self.client
         @client ||= Plugin::GitHubStatus::Client.new
       end

data/lib/fastlane/plugin/github_status/message.rb

@@ -4,6 +4,8 @@ module Fastlane
       # Immutable module object representing the last status message
       # provided by GitHub
       class Message
+        STATUS_RANKING = ['good', 'minor', 'major'].freeze
+
         # String representing one of three possible statuses:
         # * 'good' - Everything is OK
         # * 'minor' - GitHub is experiencing minor problems
@@ -28,10 +30,24 @@ module Fastlane
         #   'created_on' => '2016-06-01T16:40:35Z'
         # }
         def initialize(data_hash)
-          @status = data_hash['status']
+          @status = ENV['GITHUB_STATUS_TEST_STATUS'] || data_hash['status']
           @body = data_hash['body']
           @created_on = Time.parse(data_hash['created_on'])
         end
+
+        def status_at_least?(other_status)
+          self.class.valid_status?(other_status) && (status_ranking(status) >= status_ranking(other_status))
+        end
+
+        def self.valid_status?(status)
+          STATUS_RANKING.include?(status)
+        end
+
+        private
+
+        def status_ranking(status)
+          STATUS_RANKING.find_index(status)
+        end
       end
     end
   end

data/lib/fastlane/plugin/github_status/options.rb

@@ -0,0 +1,29 @@
+module Fastlane
+  module Plugin
+    module GitHubStatus
+      class Options
+        # Excludes 'good' as a valid choice for wanting to abort the build
+        ABORT_STATUSES = Plugin::GitHubStatus::Message::STATUS_RANKING.drop(1)
+        ABORT_CHOICES = "'#{ABORT_STATUSES.join("', '")}'"
+
+        def self.available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :abort_level,
+                                    env_name: "GITHUB_STATUS_ABORT_LEVEL",
+                                 description: "The GitHub status at or above which execution should abort. Valid values are: #{ABORT_CHOICES}",
+                                    optional: true,
+                                        type: String,
+                               default_value: nil,
+                                verify_block: proc do |value|
+                                                valid = value.nil? || ABORT_STATUSES.include?(value)
+
+                                                unless valid
+                                                  FastlaneCore::UI.user_error!("abort_level must be one of: #{ABORT_CHOICES}")
+                                                end
+                                              end)
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_status/ui.rb

@@ -17,6 +17,10 @@ module Fastlane
           FastlaneUI.message '🐙 🐱'
         end
 
+        def abort!(text)
+          FastlaneUI.user_error!(text)
+        end
+
         def status_statement(message)
           status = message.status
           colorize_for_status(status, "#{status.upcase} - #{message.body}")

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-github_status
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Furtak
@@ -106,6 +106,7 @@ files:
 - lib/fastlane/plugin/github_status/actions/github_status_action.rb
 - lib/fastlane/plugin/github_status/client.rb
 - lib/fastlane/plugin/github_status/message.rb
+- lib/fastlane/plugin/github_status/options.rb
 - lib/fastlane/plugin/github_status/ui.rb
 - lib/fastlane/plugin/github_status/version.rb
 homepage: https://github.com/mfurtak/fastlane-plugin-github_status
@@ -131,6 +132,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Provides the ability to check on GitHub server status as part of your build
+summary: Provides the ability to display and act upon GitHub server status as part
+  of your build
 test_files: []
 has_rdoc: