plan_my_stuff 0.28.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aac5ec777cf9b53a459843e9bdbf1177178fe1623457a60d266e993db3d2d93
-  data.tar.gz: 1b7089b760fa0552e3b861732472e43cab09667699e1528703809a2ce753254f
+  metadata.gz: bf390e409623eaacc5e3dcd727984ed93212cdc23847fc9a848de150d1c025af
+  data.tar.gz: 70eeabeadf4d593c5a97806ad013e24da2175123e4f6e5bf071b3beee9da2937
 SHA512:
-  metadata.gz: 84f1cc4e7dd87ed3e33f2095d3c0f57c9ad61972ffaa5ed1d9379dfb6bb0e7bc1b07491c76c6c4f4618c39b977d7240689de5552a8c9f60fe1b474c29dde2637
-  data.tar.gz: 1d355a051c6d6f0903c80558019790ab0e1d84adb8885b28b0c18b57802ed16c338ab7793ca24f535dc01980296fcc33b19eacc3acd204d08586db25d63138d4
+  metadata.gz: 928aa5abb220e785a6bb04586645af1a5bdc0c3a889f49d08ddc4882ecb0b21f5aa0bf53a724749d2458905ad58da4a116e09e31aeb59686ddeda1b16f53b9e1
+  data.tar.gz: 66d5e0ec45da7e3b5ed2e9d2a0e1a088012008a5bca1ff5dd4773d66fd3d84ad08ffb977c29ff9276611d011b25a543464d00c0063fda29786a6610d27c6166f

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.30.0
+
+### Added
+
+- The AWS deployment-completed webhook now fires a single `pipeline_deployment_completed.plan_my_stuff` batch event
+  after the per-item sweep, carrying every item that actually transitioned (payload: `:project_items`, `:issue_numbers`,
+  `:commit_sha`). Per-item `pipeline_completed.plan_my_stuff` events still fire. The batch event is skipped when nothing
+  transitioned, giving subscribers (release-notes mailer, Slack summary, changelog generator) one clean
+  "deployment finished" signal without debouncing N per-item events (closes #97).
+
+### Changed
+
+- `PlanMyStuff::Notifications.instrument` now accepts an `Array` resource. The payload key is the pluralized element
+  key (a batch of project items keys as `:project_items`, a batch of issues as `:issues`), so batch events carry a full
+  set under one key.
+- `PlanMyStuff::Pipeline.instrument` now accepts an `Array` of items for a batch event; the payload carries
+  `:issue_numbers` (the linked number of every item) in place of the single-item `:issue_number`.
+
+## 0.29.0
+
+### Changed
+
+- `Pipeline.complete_deployment!` now sets the linked issue's `Issue Status` field to `Fixed` on the auto-complete
+  success path (alongside moving the item to `Completed`). Gated on `config.issue_fields_enabled`, so completion still
+  succeeds when issue fields are disabled. The auto-complete-off early return is unchanged (closes #96).
+
 ## 0.28.0
 
 ### Added

data/README.md

@@ -698,7 +698,15 @@ The engine mounts two webhook endpoints when the pipeline is enabled:
 - `POST /webhooks/github` — takes GitHub `pull_request` events. On `closed` against a tracked branch, the gem calls `IssueLinker` to extract `#123` references from the PR body and commit messages, then transitions each linked issue (e.g. merged to main -> `start_deployment!`).
 - `POST /webhooks/aws` — takes CodeDeploy/SNS lifecycle events. On a successful deployment, the gem flips matching items to `Completed`.
 
-See `designs/release_cycle/plan.md` for the full design, including the `projects_v2_item` path that fires `Pipeline.take!` when a human drags an item to Started on github.com.
+On a successful AWS deployment the gem completes each matching item individually (one
+`pipeline_completed.plan_my_stuff` event apiece), then fires a single
+`pipeline_deployment_completed.plan_my_stuff` batch event carrying every item that actually transitioned
+(payload: `:project_items`, `:issue_numbers`, `:commit_sha`). It is skipped when nothing transitioned, so subscribers
+(release-notes mailer, Slack summary, changelog generator) get one clean "deployment finished" signal
+without debouncing the per-item events.
+
+See `designs/release_cycle/plan.md` for the full design, including the `projects_v2_item` path that fires
+`Pipeline.take!` when a human drags an item to Started on github.com.
 
 ### "Take" button
 

data/app/controllers/plan_my_stuff/issues/approvals_controller.rb

@@ -23,10 +23,11 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id])
-        issue.request_approvals!(user_ids: user_ids, user: pms_current_user)
+        find_issue
 
-        yield(issue) if block_given?
+        @issue.request_approvals!(user_ids: user_ids, user: pms_current_user)
+
+        yield(@issue) if block_given?
         return if performed?
 
         flash[:success] = 'Approvers were successfully added.'
@@ -47,7 +48,7 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id])
+        find_issue
         caller_id = pms_current_user.present? ? PlanMyStuff::UserResolver.user_id(pms_current_user) : nil
 
         case status
@@ -56,25 +57,25 @@ module PlanMyStuff
             redirect_to_unauthorized(show_path)
             return
           end
-          issue.approve!(user: pms_current_user)
+          @issue.approve!(user: pms_current_user)
           flash[:success] = 'Approval recorded.'
         when 'rejected'
           unless caller_id == target_id
             redirect_to_unauthorized(show_path)
             return
           end
-          issue.reject!(user: pms_current_user)
+          @issue.reject!(user: pms_current_user)
           flash[:success] = 'Rejection recorded.'
         else
           if caller_id != target_id && !support_user?
             redirect_to_unauthorized(show_path)
             return
           end
-          issue.revoke_approval!(user: pms_current_user, target_user_id: target_id)
+          @issue.revoke_approval!(user: pms_current_user, target_user_id: target_id)
           flash[:success] = 'Response revoked.'
         end
 
-        yield(issue) if block_given?
+        yield(@issue) if block_given?
         return if performed?
 
         redirect_to(show_path)
@@ -91,10 +92,10 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id])
-        issue.remove_approvers!(user_ids: [params[:id].to_i], user: pms_current_user)
+        find_issue
+        @issue.remove_approvers!(user_ids: [params[:id].to_i], user: pms_current_user)
 
-        yield(issue) if block_given?
+        yield(@issue) if block_given?
         return if performed?
 
         flash[:success] = 'Approver was successfully removed.'
@@ -112,9 +113,14 @@ module PlanMyStuff
           params.fetch(:approval, {}).permit(:status, :user_ids)
         end
 
+        # :nodoc:
+        def find_issue
+          @issue = PlanMyStuff::Issue.find(params[:issue_id])
+        end
+
         # @return [String]
         def show_path
-          plan_my_stuff.issue_path(params[:issue_id])
+          plan_my_stuff.issue_path(@issue || params[:issue_id])
         end
     end
   end

data/app/controllers/plan_my_stuff/webhooks/aws_controller.rb

@@ -147,7 +147,10 @@ module PlanMyStuff
         end
 
         # Finds "Release in Progress" items whose linked issue commit SHA matches the configured production
-        # commit SHA (prefix match), then completes deployment for each.
+        # commit SHA (prefix match), then completes deployment for each. After the per-item sweep, fires one batch
+        # +pipeline_deployment_completed.plan_my_stuff+ event carrying every item that actually transitioned
+        # (+complete_deployment!+ returns +nil+ when auto-complete is off, so those are excluded). The batch event is
+        # skipped when nothing transitioned so subscribers only see real deployments.
         #
         # @return [void]
         #
@@ -162,13 +165,22 @@ module PlanMyStuff
             return
           end
 
-          release_in_progress_items.each do |item|
+          completed_items = release_in_progress_items.filter_map do |item|
             next if item.draft?
 
             next unless item.issue.metadata.commit_sha&.start_with?(sha)
 
-            PlanMyStuff::Pipeline.complete_deployment!(item)
+            result = PlanMyStuff::Pipeline.complete_deployment!(item)
+            item if result.present?
           end
+
+          return if completed_items.empty?
+
+          PlanMyStuff::Pipeline.instrument(
+            'deployment_completed',
+            completed_items,
+            commit_sha: sha,
+          )
         end
 
         # Finds all pipeline project items at "Release in Progress" status.

data/lib/plan_my_stuff/engine.rb

@@ -16,7 +16,7 @@ module PlanMyStuff
       if loader.respond_to?(:eager_load_dir)
         loader.eager_load_dir(controllers_dir)
       else
-        Dir.glob(File.join(controllers_dir, '**/*.rb')).sort.each { |path| require path }
+        Dir.glob(File.join(controllers_dir, '**/*.rb')).each { |path| require path }
       end
     end
   end

data/lib/plan_my_stuff/notifications.rb

@@ -21,7 +21,8 @@ module PlanMyStuff
     # Fires +<event>.plan_my_stuff+ with a normalized payload.
     #
     # @param event [String] e.g. +'issue_created'+
-    # @param resource [Object] domain object (+Issue+, +Comment+, +ProjectItem+, ...)
+    # @param resource [Object] domain object (+Issue+, +Comment+, +ProjectItem+, ...), or an +Array+ of resources for a
+    #   batch event (keyed by the pluralized element key, e.g. +:project_items+)
     # @param user [Object, nil] explicit actor; falls back to +config.current_user+
     # @param extra [Hash] additional payload entries (+changes:+, +labels:+, +user_ids:+, ...)
     #
@@ -63,7 +64,9 @@ module PlanMyStuff
       payload.merge(extra)
     end
 
-    # Maps a resource object to its payload key.
+    # Maps a resource object to its payload key. An +Array+ recurses on its first element and pluralizes that key, so
+    # batch events carry the full set under one key (a batch of project items keys as +:project_items+, a batch of
+    # issues as +:issues+, an empty/unknown batch as +:resources+).
     #
     # @param resource [Object]
     #
@@ -74,6 +77,7 @@ module PlanMyStuff
       when PlanMyStuff::Issue then :issue
       when PlanMyStuff::Comment then :comment
       when PlanMyStuff::BaseProjectItem then :project_item
+      when Array then :"#{infer_resource_key(resource.first)}s"
       else :resource
       end
     end

data/lib/plan_my_stuff/pipeline.rb

@@ -55,13 +55,17 @@ module PlanMyStuff
     # canonical status is added to the payload as +:status+. Otherwise +event+ is used verbatim as the suffix (e.g.
     # +"removed"+, +"removed_late"+, +"testing"+).
     #
+    # +resource+ is normally a single project item (payload carries +:issue_number+). Pass an +Array+ for a batch
+    # event (e.g. the deployment-completed sweep) and the payload instead carries +:issue_numbers+ -- the linked
+    # number of every item.
+    #
     # @param event [String] status name or literal event suffix
-    # @param project_item [PlanMyStuff::BaseProjectItem]
+    # @param resource [PlanMyStuff::BaseProjectItem, Array<PlanMyStuff::BaseProjectItem>] item or batch of items
     # @param extra [Hash] additional payload entries
     #
     # @return [void]
     #
-    def instrument(event, project_item, **extra)
+    def instrument(event, resource, **extra)
       extra_to_use = { **extra }
       event_to_use = event
       if PlanMyStuff::Pipeline::Status::ALL.include?(event_to_use)
@@ -69,10 +73,17 @@ module PlanMyStuff
         event_to_use = PlanMyStuff::Pipeline::Status.key_for(event_to_use)
       end
 
+      number_fields =
+        if resource.is_a?(Array)
+          { issue_numbers: resource.map(&:number) }
+        else
+          { issue_number: resource.number }
+        end
+
       PlanMyStuff::Notifications.instrument(
         "pipeline_#{event_to_use}",
-        project_item,
-        issue_number: project_item.number,
+        resource,
+        **number_fields,
         **extra_to_use,
       )
     end
@@ -273,8 +284,10 @@ module PlanMyStuff
       items
     end
 
-    # Moves a project item to "Completed" if the linked issue has +auto_complete+ enabled. Returns +nil+ when
-    # auto-complete is off (item stays at "Release in Progress").
+    # Moves a project item to "Completed" if the linked issue has +auto_complete+ enabled, and sets the linked issue's
+    # "Issue Status" field to "Fixed". Returns +nil+ when auto-complete is off (item stays at "Release in Progress" and
+    # no field is touched). The "Issue Status" update is skipped when +config.issue_fields_enabled+ is +false+ so
+    # completion still succeeds.
     #
     # @param project_item [PlanMyStuff::ProjectItem]
     # @param deployment_id [String, nil]
@@ -288,6 +301,8 @@ module PlanMyStuff
       status = resolve_status_name(PlanMyStuff::Pipeline::Status::COMPLETED)
       result = project_item.move_to!(status)
 
+      issue.set_issue_fields!('Issue Status' => 'Fixed') if PlanMyStuff.configuration.issue_fields_enabled
+
       instrument(PlanMyStuff::Pipeline::Status::COMPLETED, project_item, deployment_id: deployment_id)
       result
     end

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 28
+    MINOR = 30
     TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Brands Insurance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-26 00:00:00.000000000 Z
+date: 2026-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails