firespring_dev_commands 2.2.1.pre.alpha.1 → 2.2.1.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b28be62e65a274b5dc6b3ac1476d926c6d1c9232a845a31279ca5f03d626a5d
-  data.tar.gz: 57ecb8d254a210ecc99b787577a58ea9e00fb761df350990fd9607c757ee71e6
+  metadata.gz: 7f7ee4edb84fcf55633780edce93e62119ba287da59fd45ce4a7b06109ce9e75
+  data.tar.gz: 3344e8910159e5b5df252b807b006c366956ce0220b2b65d6e5a92be9e958484
 SHA512:
-  metadata.gz: 5c8a062464820475012a32d643b62e68fba662fa6e1e0d87e5b5658d08916922000f62d35cd92708c8bdb765b382c08bf5f8dd64f7f4cb175591ec635f33e09e
-  data.tar.gz: 051f0483014854cc8bb4644c734b5b5b6171c5ec4dfd720f359c6b6c7e7b9d1beedcaae8975d8a65377be04b9f4e2393d2fa7bcc2af6a3df09da6a503cccf1aa
+  metadata.gz: 6f93bd21df947af3689c965be24f664fe23841c522ab2a90c2fe0b1b4642f774805426da93ffab856c03ec99e77bd06e4b5af5a83d40c833fb217826c991566a
+  data.tar.gz: 80cd78d0f4f92c7334c2908d317596782b2bec357d556983388ee6cf97e623f9210853a928f1e4823fa2536cbec0dd97af3f9243ecb3e48ee8bb244569e68bbf

data/lib/firespring_dev_commands/common.rb

@@ -7,7 +7,7 @@ module Dev
     # By default, the subshell is connected to the stdin/stdout/stderr of the current program
     # By default, the current environment is passed to the subshell
     # You can capture the output of the command by setting capture to true
-    def run_command(command, stdin: $stdin, stdout: $stdout, stderr: $stderr, env: ENV, capture: false, fail_on_error: true)
+    def run_command(command, stdin: $stdin, stdout: $stdout, stderr: $stderr, env: ENV, capture: false)
       command = Array(command)
       output = nil
 
@@ -31,7 +31,7 @@ module Dev
       unless result.exitstatus.zero?
         puts output if capture
         LOG.error "#{result.exitstatus} exit status while running [ #{command.join(' ')} ]\n".red
-        exit result.exitstatus if fail_on_error
+        exit result.exitstatus
       end
 
       output

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,22 @@ module Dev
       g.fetch('origin', prune: true)
     end
 
+    def commit_status(token:, repo_name:, branch:, 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?
+
+      # Set up the GitHub client
+      client = Octokit::Client.new(access_token: token)
+
+      # Fetch the latest commit SHA for the given branch
+      repo = "#{repo_org}/#{repo_name}"
+      ref = "heads/#{branch}"
+      sha = client.ref(repo, ref).object.sha
+
+      # Create the commit status
+      client.create_status(repo, sha, 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 BRANCH=abc123 to specify the branch 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('/')
+                branch = ENV['BRANCH'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'Repository name is required' unless repo_name
+                raise 'Branch name is required' unless branch
+
+                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:, branch:, 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 BRANCH=abc123 to specify the branch 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('/')
+                branch = ENV['BRANCH'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'Repository name is required' unless repo_name
+                raise 'Branch name is required' unless branch
+
+                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:, branch:, 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 BRANCH=abc123 to specify the branch 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('/')
+                branch = ENV['BRANCH'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'Repository name is required' unless repo_name
+                raise 'Branch name is required' unless branch
+
+                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:, branch:, 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 BRANCH=abc123 to specify the branch 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('/')
+                branch = ENV['BRANCH'].to_s.strip
+
+                raise 'GITHUB_TOKEN is required' unless token
+                raise 'Repository name is required' unless repo_name
+                raise 'Branch name is required' unless branch
+
+                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:, branch:, 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.1.pre.alpha.1'.freeze
+    VERSION = '2.2.1.pre.alpha.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.2.1.pre.alpha.1
+  version: 2.2.1.pre.alpha.3
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-25 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