plan_my_stuff 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98cbaeb499aa1b3b22018b7145d2d8e0bd86051a237230d1b5cac3e884109e10
-  data.tar.gz: a66aa1aec786adca0853eed340e1f35e2639c7aca6aafae88a421b4cc2136b5d
+  metadata.gz: bf390e409623eaacc5e3dcd727984ed93212cdc23847fc9a848de150d1c025af
+  data.tar.gz: 70eeabeadf4d593c5a97806ad013e24da2175123e4f6e5bf071b3beee9da2937
 SHA512:
-  metadata.gz: 8f4e1995d828ae83edfc94a9d2d0805b5787165e28f062bd0100f586de2c19e49fb6f9167ac0ee0ea88be5001012ffab5371315d2dcaee4b081a13e6be53a993
-  data.tar.gz: 95474b37f6f2bbd4c6074f3049086b1d643617c7c0a6dbf8562e9e0c29f9ad7bcbcabcedfda29f8e55cfcf12d5f0024a41cd69d0c9527dff91948a83e8dcde46
+  metadata.gz: 928aa5abb220e785a6bb04586645af1a5bdc0c3a889f49d08ddc4882ecb0b21f5aa0bf53a724749d2458905ad58da4a116e09e31aeb59686ddeda1b16f53b9e1
+  data.tar.gz: 66d5e0ec45da7e3b5ed2e9d2a0e1a088012008a5bca1ff5dd4773d66fd3d84ad08ffb977c29ff9276611d011b25a543464d00c0063fda29786a6610d27c6166f

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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

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/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/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

data/lib/plan_my_stuff/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Brands Insurance