Make pushing to github optional

Author: azimux

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.0.6] - 2025-05-03
+
+- Make pushing to github off by default and make failures not stop the generator
+
 ## [0.0.5] - 2025-05-03
 
 - Create github repositories as private instead of public

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foobara-empty-typescript-react-project-generator (0.0.5)
+    foobara-empty-typescript-react-project-generator (0.0.6)
       foobara (~> 0.0.116)
       foobara-files-generator (~> 0.0.1)
 
@@ -20,10 +20,10 @@ GEM
       foobara-lru-cache (~> 0.0.2)
       foobara-util (~> 0.0.11)
       inheritable-thread-vars (~> 0.0.1)
-    foobara-files-generator (0.0.6)
+    foobara-files-generator (0.0.7)
       foobara (~> 0.0.116)
     foobara-lru-cache (0.0.2)
-    foobara-rubocop-rules (0.0.8)
+    foobara-rubocop-rules (0.0.9)
       rubocop
       rubocop-rspec
     foobara-spec-helpers (0.0.4)

Rakefile

@@ -7,4 +7,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: [:spec, :rubocop]

spec/foobara/generators/write_empty_typescript_react_project_to_disk_spec.rb

@@ -11,14 +11,19 @@
   end
   let(:empty_typescript_react_project_config) do
     {
-      project_dir:
+      project_dir:,
+      push_to_github: true
     }
   end
   let(:project_dir) { "test-project" }
   let(:output_directory) { "#{__dir__}/../../../tmp/rspec-output" }
 
   before do
-    allow(command).to receive_messages(git_commit: nil, rubocop_autocorrect: nil)
+    # rubocop:disable RSpec/AnyInstance
+    # Stubbing these to let more lines of the code be hit by the test suite
+    allow_any_instance_of(described_class).to receive(:push_to_github_failed).and_return(nil)
+    # rubocop:enable RSpec/AnyInstance
+
     FileUtils.rm_rf output_directory
   end
 

src/empty_typescript_react_project_config.rb

@@ -7,6 +7,7 @@ class EmptyTypescriptReactProjectConfig < Foobara::Model
         attributes do
           project_dir :string, :required
           github_organization :string
+          push_to_github :boolean, default: false
         end
       end
     end

src/write_empty_typescript_react_project_to_disk.rb

@@ -44,6 +44,10 @@ def project_directory
           Pathname.new(path).realpath.to_s
         end
 
+        def push_to_github?
+          empty_typescript_react_project_config.push_to_github
+        end
+
         def generate_file_contents
           self.paths_to_source_code = run_subcommand!(GenerateEmptyTypescriptReactProject,
                                                       empty_typescript_react_project_config.attributes)
@@ -91,10 +95,13 @@ def run_post_generation_tasks
           eslint_fix
           git_add_all
           git_commit_generated_files
-          gh_repo_create
-          git_add_remote_origin
           git_branch_main
-          push_to_github
+
+          if push_to_github?
+            gh_repo_create
+            git_add_remote_origin
+            push_to_github
+          end
         end
 
         def fix_uncorrectable_lint_violations
@@ -152,25 +159,50 @@ def git_repo_path
           "#{org}/#{empty_typescript_react_project_config.project_dir}"
         end
 
+        attr_accessor :push_to_github_failed
+
+        def push_to_github_failed?
+          push_to_github_failed
+        end
+
         def gh_repo_create
+          return if push_to_github_failed?
+
           cmd = "gh repo create --private --push --source=. #{git_repo_path}"
 
           Dir.chdir project_directory do
-            run_cmd_and_write_output(cmd, raise_if_fails: false)
+            exit_status = run_cmd_and_write_output(cmd, raise_if_fails: false)
+
+            unless exit_status&.success?
+              self.push_to_github_failed = true
+            end
           end
         end
 
         def git_add_remote_origin
+          return if push_to_github_failed?
+
           git_remote_cmd = "git remote"
           git_remote_add_cmd = "git remote add origin git@github.com:#{git_repo_path}.git"
 
           Dir.chdir project_directory do
             remotes = run_cmd_and_return_output(git_remote_cmd)
 
             if remotes !~ /^origin$/
-              run_cmd_and_write_output(git_remote_add_cmd)
+              exit_status = run_cmd_and_write_output(git_remote_add_cmd)
+
+              unless exit_status&.success?
+                # :nocov:
+                self.push_to_github_failed = true
+                # :nocov:
+              end
             end
           end
+        rescue CouldNotExecuteError => e
+          # :nocov:
+          self.push_to_github_failed = true
+          warn e.message
+          # :nocov:
         end
 
         def git_branch_main
@@ -185,7 +217,11 @@ def push_to_github
           cmd = "git push -u origin main"
 
           Dir.chdir project_directory do
-            run_cmd_and_write_output(cmd, raise_if_fails: false)
+            exit_status = run_cmd_and_write_output(cmd, raise_if_fails: false)
+
+            unless exit_status&.success?
+              self.push_to_github_failed = true
+            end
           end
         end
       end

version.rb

@@ -1,7 +1,7 @@
 module Foobara
   module Generators
     module EmptyTypescriptReactProjectGenerator
-      VERSION = "0.0.5".freeze
+      VERSION = "0.0.6".freeze
 
       local_ruby_version = File.read("#{__dir__}/.ruby-version").chomp
       local_ruby_version_minor = local_ruby_version[/\A(\d+\.\d+)\.\d+\z/, 1]