firespring_dev_commands 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 599f3f484514462356186c8d52adfac32e8aa925f7aeaa488bb5fa109db678f3
-  data.tar.gz: 3dffab80edf84b75d073adfc21c1a2c3e0d9dcc666a526f2bda2d5471ff24d6e
+  metadata.gz: d8423e2a17f9e8a139792033ae83b26554120e41dcca5c16f2060bfc5abbf174
+  data.tar.gz: bd7d8d48505e4a81d025aab930d699b8684f585015347ee3f5fb18f3f6744d7f
 SHA512:
-  metadata.gz: 0ea2c7d6d09e1e5ad6a85ee3d7d3e90826018bee1afc7c1ce1a206ca8514b658c8ef29534dc5b4082bf185d1540a9292218eb3836f6c3405b44d3ff10d98b484
-  data.tar.gz: c06fa865de8acedba8ec7b2934094f7a03fb46e2e1d5a116fc2b12fa4febcf6874940771a843bb022f5f571d5b77e9d4f00d5b3f4930f4cd2f16aa44293a66dd
+  metadata.gz: 617153db6a841f9b95e7406d2bf0b32a2936af106a7c40f3dd36d4b4a28f75c3c9dd7fa1af482f3192d7f500aa2d7f2da9b18f121de9cccadaada54a9f589084
+  data.tar.gz: 1cc7768227e3f5589b1485306ac411016088bd7bad19cfb13af1c4fc7bb22692564e5f68ef1a1f7a48b38bce98f63844a302966f58e0ea8aae1e7620a8325f28

data/lib/firespring_dev_commands/git.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'git'
+require 'octokit'
 
 module Dev
   # Class for performing git functions
@@ -408,7 +409,10 @@ module Dev
     # Clones the repo_name into the dir
     # Optionally specify a repo_org
     # Optionally specify a branch to check out (defaults to the repository default branch)
-    def clone_repo(dir:, repo_name:, repo_org: 'firespring', branch: nil, depth: nil)
+    def clone_repo(dir:, repo_name:, repo_org: nil, branch: nil, depth: nil)
+      # TODO: Split out the default of 'firespring' into a configuration variable
+      repo_org = 'firespring' if repo_org.to_s.strip.empty?
+
       if Dir.exist?("#{dir}/.git")
         puts "#{dir} already cloned".light_green
         return
@@ -425,6 +429,19 @@ module Dev
       g.fetch('origin', prune: true)
     end
 
+    def commit_status(token:, repo_name:, commit_id:, status:, repo_org: nil, options: {})
+      # TODO: Split out the default of 'firespring' into a configuration variable
+      repo_org = 'firespring' if repo_org.to_s.strip.empty?
+      repo = "#{repo_org}/#{repo_name}"
+
+      # Set up the GitHub client
+      client = Octokit::Client.new(access_token: token)
+
+      # Create the commit status
+      puts "Tagging commit #{commit_id} in #{repo} as #{status} for #{options[:context]}"
+      client.create_status(repo, commit_id, status, options)
+    end
+
     # Builds an ssh repo URL using the org and repo name given
     def ssh_repo_url(name, org)
       "git@github.com:#{org}/#{name}.git"

data/lib/firespring_dev_commands/templates/git.rb

@@ -159,6 +159,154 @@ module Dev
           end
         end
       end
+
+      # Create the rake task for the git commit status pending task.
+      def create_commit_status_pending_task!
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          namespace :git do
+            return if exclude.include?(:commit_status)
+
+            namespace :commit_status do
+              desc 'Add pending status to commit' \
+                   "\n\tuse GITHUB_TOKEN=abc123 enables write options for the check (required)" \
+                   "\n\tuse REPOSITORY=abc123 to specify the repository (required)" \
+                   "\n\tuse COMMIT_ID=abc123 to specify the commit id of code (required)" \
+                   "\n\tuse CONTEXT=abc123 names the check on the PR (optional)" \
+                   "\n\tuse TARGET_URL={url} adds 'detail' hyperlink to check on the PR (optional)"
+              task :pending do
+                status = 'pending'
+                token = ENV['GITHUB_TOKEN'].to_s.strip
+                repo_org, repo_name = ENV['REPOSITORY'].to_s.strip.split('/')
+                commit_id = ENV['COMMIT_ID'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'REPOSITORY is required' unless repo_name
+                raise 'COMMIT_ID is required' unless commit_id
+
+                options = {}
+                options[:context] = ENV['CONTEXT'].to_s.strip unless ENV['CONTEXT'].to_s.strip.empty?
+                options[:target_url] = ENV['TARGET_URL'].to_s.strip unless ENV['TARGET_URL'].to_s.strip.empty?
+
+                Dev::Git.new.commit_status(token:, repo_name:, commit_id:, status:, repo_org:, options:)
+              end
+            end
+          end
+        end
+      end
+
+      # Create the rake task for the git commit status success task.
+      def create_commit_status_success_task!
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          namespace :git do
+            return if exclude.include?(:commit_status)
+
+            namespace :commit_status do
+              desc 'Add success status to commit' \
+                   "\n\tuse GITHUB_TOKEN=abc123 enables write options for the check (required)" \
+                   "\n\tuse REPOSITORY=abc123 to specify the repository (required)" \
+                   "\n\tuse COMMIT_ID=abc123 to specify the commit id of code (required)" \
+                   "\n\tuse CONTEXT=abc123 names the check on the PR (optional)" \
+                   "\n\tuse TARGET_URL={url} adds 'detail' hyperlink to check on the PR (optional)"
+              task :success do
+                status = 'success'
+                token = ENV['GITHUB_TOKEN'].to_s.strip
+                repo_org, repo_name = ENV['REPOSITORY'].to_s.strip.split('/')
+                commit_id = ENV['COMMIT_ID'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'REPOSITORY is required' unless repo_name
+                raise 'COMMIT_ID is required' unless commit_id
+
+                options = {}
+                options[:context] = ENV['CONTEXT'].to_s.strip unless ENV['CONTEXT'].to_s.strip.empty?
+                options[:target_url] = ENV['TARGET_URL'].to_s.strip unless ENV['TARGET_URL'].to_s.strip.empty?
+
+                Dev::Git.new.commit_status(token:, repo_name:, commit_id:, status:, repo_org:, options:)
+              end
+            end
+          end
+        end
+      end
+
+      # Create the rake task for the git commit status error task.
+      def create_commit_status_error_task!
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          namespace :git do
+            return if exclude.include?(:commit_status)
+
+            namespace :commit_status do
+              desc 'Add error status to commit' \
+                   "\n\tuse GITHUB_TOKEN=abc123 enables write options for the check (required)" \
+                   "\n\tuse REPOSITORY=abc123 to specify the repository (required)" \
+                   "\n\tuse COMMIT_ID=abc123 to specify the commit id of code (required)" \
+                   "\n\tuse CONTEXT=abc123 names the check on the PR (optional)" \
+                   "\n\tuse TARGET_URL={url} adds 'detail' hyperlink to check on the PR (optional)"
+              task :error do
+                status = 'error'
+                token = ENV['GITHUB_TOKEN'].to_s.strip
+                repo_org, repo_name = ENV['REPOSITORY'].to_s.strip.split('/')
+                commit_id = ENV['COMMIT_ID'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'REPOSITORY is required' unless repo_name
+                raise 'COMMIT_ID is required' unless commit_id
+
+                options = {}
+                options[:context] = ENV['CONTEXT'].to_s.strip unless ENV['CONTEXT'].to_s.strip.empty?
+                options[:target_url] = ENV['TARGET_URL'].to_s.strip unless ENV['TARGET_URL'].to_s.strip.empty?
+
+                Dev::Git.new.commit_status(token:, repo_name:, commit_id:, status:, repo_org:, options:)
+              end
+            end
+          end
+        end
+      end
+
+      # Create the rake task for the git commit status failure task.
+      def create_commit_status_failure_task!
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          namespace :git do
+            return if exclude.include?(:commit_status)
+
+            namespace :commit_status do
+              desc 'Add failure status to commit' \
+                   "\n\tuse GITHUB_TOKEN=abc123 enables write options for the check (required)" \
+                   "\n\tuse REPOSITORY=abc123 to specify the repository (required)" \
+                   "\n\tuse COMMIT_ID=abc123 to specify the commit id of code (required)" \
+                   "\n\tuse CONTEXT=abc123 names the check on the PR (optional)" \
+                   "\n\tuse TARGET_URL={url} adds 'detail' hyperlink to check on the PR (optional)"
+              task :failure do
+                status = 'failure'
+                token = ENV['GITHUB_TOKEN'].to_s.strip
+                repo_org, repo_name = ENV['REPOSITORY'].to_s.strip.split('/')
+                commit_id = ENV['COMMIT_ID'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'REPOSITORY is required' unless repo_name
+                raise 'COMMIT_ID is required' unless commit_id
+
+                options = {}
+                options[:context] = ENV['CONTEXT'].to_s.strip unless ENV['CONTEXT'].to_s.strip.empty?
+                options[:target_url] = ENV['TARGET_URL'].to_s.strip unless ENV['TARGET_URL'].to_s.strip.empty?
+
+                Dev::Git.new.commit_status(token:, repo_name:, commit_id:, status:, repo_org:, options:)
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.2.3'.freeze
+    VERSION = '2.2.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +276,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: ox
   requirement: !ruby/object:Gem::Requirement