deploy_pin 1.7.5 → 1.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87d64a7e5ec829127f031b66d3ef68f14483d3f44d8ca6dd1c23a7d6defcdf8
-  data.tar.gz: e7a263cc89bdba41ab34eb7b90a0ac4bb38e7f0936a8684af965f31fbce0bb05
+  metadata.gz: 524fa7d4e78224d393bf12ce1dc483a657a3e21f6bfe3d09c041f165be385082
+  data.tar.gz: dde01336587e779b9056a82f7ed983ee644bcab058930b6c39218b0dcfb76ac3
 SHA512:
-  metadata.gz: a7f4d72a7c7856f3b6d1bfc70c4a1f0992eb3f8f0b956c4044c203d172bb57578b731292b664345627c925a9e77c9d73d082ae281941bf2312f1d431aeb4720a
-  data.tar.gz: 1e8b9d6c4591e65ff806b4a7d80289640a861a49156676606d54a29b050c8f598c1d5b36499db184fa7f41bfe659cea72937d21420eeaa7935d7c63834b6fdd7
+  metadata.gz: 69d65171dfd4ba1fcdee65769b0bdc181a9375a2b3a76f900fbc4faea36056f1164364143917e75ba7569bbbd528a2036bb525f9979cc2af17ae0c7d0bf60680
+  data.tar.gz: 1912162855e042a1177fe0cfb40446eefbc569f8615ae9dc303fd91267452a158c18cd43706d1ddf7291bdcd647ae1e13b5d83b43f18d44e7b8e102537f4b872

data/README.md

@@ -226,6 +226,13 @@ rails g deploy_pin:task some_task_title --recurring --identifier 5
 rails g deploy_pin:task some_task_title --parallel --recurring --identifier 5
 ```
 
+## Mark Tasks as Done
+
+```bash
+rake deploy_pin:mark_done['identifier_1, identifier_2'] # marks specific tasks as done 
+rake deploy_pin:mark_done # marks all tasks as done. useful in seed file
+```
+
 ## DeploymentStateTrack
 In the initializer
 ```ruby
@@ -250,6 +257,27 @@ Around the deployment
 bundle exec rake deploy_pin:run[I, II, III] - # enters to ongoing state before "I" and leaves it after "III" so all tasks in I, II, III have DeployPin.ongoing_deployment? == true
 bundle exec rake deploy_pin:run[rollback] - # enters "pending state"
 ```
+## Continue on Error
+
+By default, if a task raises an error, the entire deploy pin run is aborted. You can configure `continue_on_error` to rescue failures, log them, and still mark the task as done. This is useful in CI environments where external services may be unavailable.
+
+```ruby
+# config/initializers/deploy_pin.rb
+DeployPin.setup do
+  continue_on_error true
+end
+```
+
+Or conditionally via environment variable:
+
+```ruby
+DeployPin.setup do
+  continue_on_error ENV.fetch("DEPLOY_PIN_CONTINUE_ON_ERROR", "false") == "true"
+end
+```
+
+When enabled, failed tasks will log the error and continue to the next task without halting execution.
+
 ## Similar Gems
 - https://github.com/ilyakatz/data-migrate
 - https://github.com/Shopify/maintenance_tasks
@@ -275,7 +303,7 @@ To ensure your changes meet the required standards and pass all tests before sub
 Use the following command to simulate the workflow locally:
 
 ```bash
-act pull_request --secret-file .env --container-architecture linux/amd64 -W .github/workflows -j rspec
+act pull_request --secret-file .env --container-architecture linux/amd64 -W .github/workflows -j test
 ```
 
 This command does the following:

data/lib/deploy_pin/collector.rb

@@ -11,7 +11,6 @@ module DeployPin
 
     # :reek:TooManyStatements
     def run
-      # cache tasks
       tasks = init_tasks
       tasks.each_with_index do |task, index|
         DeployPin.task_wrapper.call(task, -> { process(tasks, task, index) })
@@ -34,8 +33,17 @@ module DeployPin
       end
     end
 
+    # :reek:FeatureEnvy
+    def mark_done
+      tasks = init_tasks
+      tasks.each do |task|
+        task.prepare
+        task.mark
+      end
+    end
+    # :reek:FeatureEnvy
+
     def executable
-      # cache tasks
       tasks = init_tasks
       tasks.map.with_index do |task, index|
         task if tasks[0..index].none? { |other_task| task.eql?(other_task) }
@@ -60,7 +68,7 @@ module DeployPin
 
         # run if executable
         if executable
-          duration = execution_duration { run_with_timeout(task) { task.run } }
+          duration = execution_duration { run_task_safely(task) }
           DeployPin.run_formatter.call(index, tasks.count, task, executable, false, duration)
         end
 
@@ -69,6 +77,15 @@ module DeployPin
       # :reek:TooManyStatements
       # :reek:FeatureEnvy
 
+      def run_task_safely(task)
+        run_with_timeout(task) { task.run }
+      rescue StandardError => e
+        raise unless DeployPin.continue_on_error
+
+        DeployPin::Runner.print("[DeployPin] Task #{task.identifier} failed: #{e.message}".red)
+        DeployPin::Runner.print('[DeployPin] Continuing due to continue_on_error configuration'.yellow)
+      end
+
       # :reek:UtilityFunction
       def files
         Dir["#{DeployPin.tasks_path}/*.rb"]

data/lib/deploy_pin/runner.rb

@@ -15,6 +15,10 @@ module DeployPin
       DeployPin::Collector.new(identifiers:).short_list
     end
 
+    def self.mark_done(identifiers:)
+      DeployPin::Collector.new(identifiers:).mark_done
+    end
+
     def self.summary(identifiers:)
       # print summary
       self.print('======= Summary ========')

data/lib/deploy_pin/task.rb

@@ -2,7 +2,8 @@
 
 # Task wrapper
 module DeployPin
-  class Task
+  # :reek:TooManyMethods
+  class Task # rubocop:disable Metrics/ClassLength
     extend ::DeployPin::ParallelWrapper
     include ::DeployPin::ParallelWrapper
 
@@ -73,7 +74,8 @@ module DeployPin
       !explicit_timeout? && !parallel?
     end
 
-    def parse
+    # :reek:TooManyStatements
+    def parse # rubocop:disable Metrics/MethodLength
       each_line do |line|
         case line.strip
         when /\A# (-?\d+):(\w+):?(recurring)?/
@@ -92,6 +94,7 @@ module DeployPin
         end
       end
     end
+    # :reek:TooManyStatements
 
     def each_line(&block)
       if file.starts_with?('# no_file_task')
@@ -146,4 +149,5 @@ module DeployPin
         @parallel
       end
   end
+  # :reek:TooManyMethods
 end

data/lib/deploy_pin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeployPin
-  VERSION = '1.7.5'
+  VERSION = '1.7.7'
 end

data/lib/deploy_pin.rb

@@ -15,6 +15,7 @@ require 'colorize'
 
 module DeployPin
   OPTIONS = %i[
+    continue_on_error
     deployment_state_transition
     fallback_group
     groups
@@ -27,13 +28,14 @@ module DeployPin
   ].freeze
 
   DEFAULTS = {
+    continue_on_error: false,
     task_wrapper: ->(_task, task_runner) { task_runner.call }
   }.freeze
 
   OPTIONS.each do |option|
     instance_eval %{
       def #{option}(val = nil)
-        return @#{option} unless val.present?
+        return @#{option} if val.nil?
 
         @#{option} = val
       end

data/lib/tasks/deploy_pin_tasks.rake

@@ -22,4 +22,11 @@ namespace :deploy_pin do
     DeployPin::Runner.short_list(**args)
     DeployPin::Runner.summary(**args)
   end
+
+  task :mark_done, [:identifiers] => :environment do |_t, args|
+    args.with_defaults(identifiers: DeployPin.groups)
+
+    DeployPin::Runner.mark_done(**args)
+    DeployPin::Runner.summary(**args)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.7.7
 platform: ruby
 authors:
 - Viktor Sych
@@ -279,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: pin some task around deployment
 test_files: []