apadmi_grout 3.0.0.pre → 3.0.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc48519c5e224b346eaa77b07d4953135348913e6a084d5fef4c4182f4592a4
-  data.tar.gz: 48ba7a5d12682e02463243336f9bcea8ffb35d728f2cc8f1512551e736a96444
+  metadata.gz: b3d9943e3bd7d774d59d0feaef83862207ae074275e24bd228c0cac4874dc0ab
+  data.tar.gz: f79e4681f4a5289e9004f0c1dbaeaf3f1342c765858255c19ea2a733cee4b7fb
 SHA512:
-  metadata.gz: 57cadb72f942f55fc386ac2c8669038bbc83a7418f5c8537332555f85a9950e1fd116eacef5ccaece3bed42e0cc1cf76bfa9cf59b262c3325ae911f61eac92e0
-  data.tar.gz: 0a18b6dce1c6dde627f3931bc320967ebfb89908ecd0f6faa95ad280697a7201258922e65c6b26e64ce1f3c86ddceb25a9446b0773b5d73bb2f132537504ab7a
+  metadata.gz: eccdfe011afc6c1af759199b25beaf375436aef06574d47c347cf8699839830c815b28eb9dbf444d793110e3f4a2adfcf3adb178b2c300446b2f42fbec934e38
+  data.tar.gz: 2f893c7b6d7e383cfc199f59752a1574e6660a2a5fb191028816a1dfa0712e5cd19c2db48cf113f348e1142f39c6e9d2ebfc0a30567484d7fa3aa00186a3bd48

data/CHANGELOG.md

@@ -7,6 +7,7 @@
 * Support analysing squash merges for release notes (breaking change: renamed `merge_changelog` function in git_utils)
 * Add optional environment field to release notes, displayed between version and build date
 * Replace Bitrise env vars, and add a migration doc to v3
+* Support linking pages by URL as related work to Jira fix versions
 
 ## [2.10.0] - 2025-09-11
 * Temporarily point jira-ruby active pull request to point to JIRA apis that haven't been removed.

data/lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_ado_action.rb

@@ -60,7 +60,7 @@ module Apadmi
         final_list = issues.filter do |issue|
           # Flag the ticket if it doesn't include in either changelog since
           # this means the ticket is likely in an incorrect state
-          decide_should_include(changelog_ids, custom_flag_messages, invert_changelog_ids, issue)
+          decide_should_include?(changelog_ids, custom_flag_messages, invert_changelog_ids, issue)
         end
 
         @logger.message("Final list: #{final_list.map(&:key).join(", ")}")
@@ -69,7 +69,7 @@ module Apadmi
 
       private
 
-      def decide_should_include(changelog_ids, custom_flag_messages, invert_changelog_ids, issue)
+      def decide_should_include?(changelog_ids, custom_flag_messages, invert_changelog_ids, issue)
         if !changelog_ids.include?(issue.key) && !invert_changelog_ids.include?(issue.key)
           @ado_board_service.flag_ticket(
             issue.key,

data/lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_jira_action.rb

@@ -68,7 +68,7 @@ module Apadmi
           issues.filter do |issue|
             # Decide whether to include this ticket based on PRs
             status = process_prs(issue, custom_flag_messages)
-            decide_should_include(issue, status, changelog_ids)
+            decide_should_include?(issue, status, changelog_ids)
           end
         else
           issues
@@ -78,7 +78,7 @@ module Apadmi
       # @param issue [Apadmi::Grout::Issue]
       # @param pr_status [Int] status of whether or not we can move
       # @param changelog_ids [Array<String>] the ticket ids pulled from git
-      def decide_should_include(issue, pr_status, changelog_ids)
+      def decide_should_include?(issue, pr_status, changelog_ids)
         # For merged PRs, check if the ticket appears in the changelog.
         # If it doesn't then it's likely it was merged AFTER this release build was triggered and shouldn't be moved
         # by this build

data/lib/apadmi/grout/actions/generate_release_notes_action/generate_release_notes_action.rb

@@ -27,7 +27,7 @@ module Apadmi
       private
 
       def render_classified_issues(template, classified_issues)
-        return if classified_issues.empty
+        return if classified_issues.empty?
 
         CustomMustache.render(
           template,

data/lib/apadmi/grout/di.rb

@@ -10,8 +10,7 @@ module Apadmi
       :move_tickets_action,
       :find_tickets_to_move_action,
       :issues_from_changelog_action,
-      :generate_release_notes_action,
-      keyword_init: true
+      :generate_release_notes_action
     ) do
       # @param [Apadmi::Grout::JiraConfig] jira_config
       # @param [Logger] logger

data/lib/apadmi/grout/models/ado_config.rb

@@ -6,8 +6,7 @@ module Apadmi
       :personal_access_token,
       :base_url,
       :flag_tag,
-      :expand_type,
-      keyword_init: true
+      :expand_type
     ) do
       def initialize(personal_access_token:,
                      base_url:,

data/lib/apadmi/grout/models/bitrise.rb

@@ -9,7 +9,7 @@ module Apadmi
     STATUS_ABORTED_SUCCESS = 4
 
     BitriseBuild = Struct.new(:triggered_at, :slug, :status, :commit_hash) do
-      def finished_with_success
+      def finished_with_success?
         status == STATUS_SUCCESS
       end
     end
@@ -17,7 +17,7 @@ module Apadmi
     Artifact = Struct.new(:title, :download_url)
 
     TriggeredBitriseBuild = Struct.new(:build_number, :build_slug, :build_url, :message, :service, :slug, :status, :triggered_workflow) do
-      def finished_with_success
+      def finished_with_success?
         status == STATUS_SUCCESS
       end
 

data/lib/apadmi/grout/models/confluence_config.rb

@@ -5,9 +5,7 @@ module Apadmi
     ConfluenceConfig = Struct.new(
       :base_url,
       :client_id,
-      :client_secret,
-      keyword_init: true
-    ) do
-    end
+      :client_secret
+    )
   end
 end

data/lib/apadmi/grout/models/find_tickets_options.rb

@@ -3,7 +3,7 @@
 module Apadmi
   module Grout
     # Generic find tickets options
-    class FindTicketsOptions; end
+    class FindTicketsOptions; end # rubocop:disable Lint/EmptyClass
 
     # Jira specific find tickets options
     class JiraFindTicketsOptions < FindTicketsOptions

data/lib/apadmi/grout/models/jira_config.rb

@@ -7,8 +7,7 @@ module Apadmi
       :api_token,
       :base_url,
       :context_path,
-      :project_key,
-      keyword_init: true
+      :project_key
     )
   end
 end

data/lib/apadmi/grout/models/release_notes_config.rb

@@ -15,7 +15,7 @@ module Apadmi
       :others
     ) do
       # @return returns true if all categories are empty
-      def empty
+      def empty?
         tasks.empty? && features.empty? &&
           improvements.empty? && defects.empty? && others.empty?
       end
@@ -45,19 +45,19 @@ module Apadmi
       :templates,
       :environment
     ) do
-      def has_min_os_version
+      def has_min_os_version?
         !min_os_version.nil? && !min_os_version.blank?
       end
 
-      def has_environment
+      def has_environment?
         !environment.nil? && !environment.blank?
       end
 
-      def has_moved_issues
+      def has_moved_issues?
         !moved_issues.empty?
       end
 
-      def has_release_issues
+      def has_release_issues?
         !release_issues.empty?
       end
     end

data/lib/apadmi/grout/models/release_notes_templates.rb

@@ -10,31 +10,31 @@ module Apadmi
 ### Version
 {{config.app_version}}
 
-{{#config.has_environment}}
+{{#config.has_environment?}}
 ### Environment
 {{config.environment}}
 
-{{/config.has_environment}}
+{{/config.has_environment?}}
 ### Build date
 {{config.date}}
 
-{{#config.has_min_os_version}}
+{{#config.has_min_os_version?}}
 ### Minimum Supported OS
 {{config.min_os_version}}
 
-{{/config.has_min_os_version}}
+{{/config.has_min_os_version?}}
 ### Build Details
 Commit Hash: {{config.commit_hash}}
 [CI/CD build \#{{config.ci_build_number}}]({{config.ci_build_url}})
 
-{{#config.has_moved_issues}}
+{{#config.has_moved_issues?}}
 ## Tickets Moved By This Build
 {{ rendered_moved_issues }}
-{{/config.has_moved_issues}}
-{{#config.has_release_issues}}
+{{/config.has_moved_issues?}}
+{{#config.has_release_issues?}}
 ## Sprint Release notes
 {{ rendered_release_issues }}
-{{/config.has_release_issues}}}
+{{/config.has_release_issues?}}}
       end
 
       def default_list_template

data/lib/apadmi/grout/service/bitrise_service/bitrise_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "open-uri"
+require "net/http"
 require "fileutils"
 
 module Apadmi
@@ -59,11 +59,7 @@ module Apadmi
         FileUtils.mkdir_p output_dir
 
         artifacts.each do |item|
-          File.open("#{output_dir}/#{item.title}", "wb") do |file|
-            # rubocop:disable Security/Open
-            file.write URI.open(item.download_url).read
-            # rubocop:enable Security/Open
-          end
+          File.binwrite("#{output_dir}/#{item.title}", Net::HTTP.get(URI(item.download_url)))
         end
         artifacts
       end

data/lib/apadmi/grout/service/board_service/ado_board_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./board_service"
+require_relative "board_service"
 
 module Apadmi
   module Grout
@@ -169,14 +169,14 @@ module Apadmi
 
         payload = if user
                     [{
-                      "op": "add",
-                      "path": "/fields/System.AssignedTo",
-                      "value": user
+                      op: "add",
+                      path: "/fields/System.AssignedTo",
+                      value: user
                     }]
                   else
                     [{
-                      "op": "remove",
-                      "path": "/fields/System.AssignedTo"
+                      op: "remove",
+                      path: "/fields/System.AssignedTo"
                     }]
                   end
         update_ticket(key, payload)
@@ -218,11 +218,11 @@ module Apadmi
 
       # @return [String]
       def get_options_filter(component, options = nil)
-        tags = (options&.required_tags || []).push(*component).filter { |it| !it.blank? }
-        not_tags = (options&.not_tags || []).filter { |it| !it.blank? }
+        tags = (options&.required_tags || []).push(*component).filter { |tag| !tag.blank? }
+        not_tags = (options&.not_tags || []).filter { |tag| !tag.blank? }
         additional_fields = (options&.additional_fields || {}).reject { |k, _v| k.blank? }
 
-        raise "Tags can either be required or not required, not both" unless (tags & not_tags).empty?
+        raise "Tags can either be required or not required, not both" if tags.intersect?(not_tags)
 
         tags_filter = tags.map { |tag| " AND [System.Tags] CONTAINS '#{tag}' " }.join(" ")
         not_tags_filter = not_tags.map { |tag| " AND [System.Tags] NOT CONTAINS '#{tag}'" }.join(" ")

data/lib/apadmi/grout/service/board_service/board_service.rb

@@ -37,12 +37,31 @@ module Apadmi
         raise "Unimplemented :("
       end
 
+      # @param [String] _version_name
+      # @param [Boolean, nil] _released
+      # @param [String, nil] _description
+      def update_version(_version_name, _released: nil, _description: nil)
+        raise "Unimplemented :("
+      end
+
+      # @param [Array<Apadmi::Grout::Issue>] _issues
+      # @param [Array<String>] _version_names
+      def assign_fixversion_to_tickets(_issues, _version_names)
+        raise "Unimplemented :("
+      end
+
       # @param [String] _key
       # @param [Array<String>] _version_strings
       def assign_fixversions(_key, _version_strings)
         raise "Unimplemented :("
       end
 
+      # @param [String] _key
+      # @param [Array<String>] _version_names
+      def remove_fixversions(_key, _version_names)
+        raise "Unimplemented :("
+      end
+
       # @param [String] _key
       # @return [Array<String>]
       def get_ticket_fixversions(_key)
@@ -54,6 +73,13 @@ module Apadmi
       def transition_issue(_issue, _state_name)
         raise "Unimplemented :("
       end
+
+      # @param [String] _version_name
+      # @param [String] _url
+      # @param [String] _title
+      def add_version_related_work(_version_name, _url, _title)
+        raise "Unimplemented :("
+      end
     end
   end
 end

data/lib/apadmi/grout/service/board_service/jira_board_service.rb

@@ -100,7 +100,7 @@ module Apadmi
         jql_search = "project = '#{@project}' AND issue IN (#{key})"
         response = @jira_client.Issue.jql(jql_search, { fields: ["comment"], max_results: 1000 }).uniq
         comments = response[0].comments.reverse
-        !comments.empty? ? comments[0] : nil
+        comments.empty? ? nil : comments[0]
       end
 
       # @param [String] key
@@ -149,7 +149,7 @@ module Apadmi
       # @param [String] component
       # @return [Array<Apadmi::Grout::Issue>]
       def get_ticket_subtask(keys, component = nil)
-        jql_search = "project = '#{@project}' AND parent IN #{keys.to_s.gsub("[", "(").gsub("]", ")")}"\
+        jql_search = "project = '#{@project}' AND parent IN #{keys.to_s.gsub("[", "(").gsub("]", ")")}" \
                       + (component.nil? ? "" : " AND component IN ('#{component}')")
         convert(@jira_client.Issue.jql(jql_search, { max_results: 1000, fields: ["*navigable"] }).uniq)
       end
@@ -160,9 +160,9 @@ module Apadmi
       def create_version(release_date, name)
         version = @jira_client.Version.build
         version.save!({
-                        "project": @project,
-                        "name": name,
-                        "releaseDate": release_date
+                        project: @project,
+                        name: name,
+                        startDate: release_date
                       })
         version
       end
@@ -170,7 +170,7 @@ module Apadmi
       # @param [int] version_id
       # @param [int] move_version_id
       def delete_version(version_id, move_version_id)
-        payload = "{\"moveFixIssuesTo\": #{move_version_id}, \"moveAffectedIssuesTo\": #{move_version_id}, "\
+        payload = "{\"moveFixIssuesTo\": #{move_version_id}, \"moveAffectedIssuesTo\": #{move_version_id}, " \
                   "\"customFieldReplacementList\": []}"
         @network_service.do_post("/rest/api/2/version/#{version_id}/removeAndSwap", payload)
       end
@@ -180,6 +180,41 @@ module Apadmi
         @jira_client.Project.find(@project).versions
       end
 
+      # @param [String] version_name
+      # @param [Boolean, nil] released omit to leave unchanged
+      # @param [String, nil] description omit to leave unchanged
+      def update_version(version_name, released: nil, description: nil)
+        raise ArgumentError, "Must provide at least one of: released, description" if released.nil? && description.nil?
+
+        version = all_versions.find { |v| v.name == version_name }
+        raise "Version '#{version_name}' not found" if version.nil?
+
+        fields = {}
+        fields[:released] = released unless released.nil?
+        fields[:description] = description unless description.nil?
+        @network_service.do_put("/rest/api/2/version/#{version.id}", fields.to_json)
+      end
+
+      # Assigns one or more fix versions to all given issues that are missing them.
+      # Filters in-memory from the already-fetched issue objects — no extra network calls.
+      # Each issue gets a single PUT containing only the versions it is missing.
+      # @param [Array<Apadmi::Grout::Issue>] issues
+      # @param [Array<String>] version_names
+      def assign_fixversion_to_tickets(issues, version_names)
+        return if issues.empty? || version_names.empty?
+
+        versions = create_or_get_versions(version_names)
+
+        issues.each do |issue|
+          existing_ids = issue.raw_object.fixVersions.map(&:id)
+          missing = versions.reject { |v| existing_ids.include?(v.id) }
+          next if missing.empty?
+
+          adds = missing.map { |v| "{\"add\": {\"id\": \"#{v.id}\"}}" }.join(", ")
+          @network_service.do_put("/rest/api/2/issue/#{issue.key}", "{\"update\": {\"fixVersions\": [#{adds}]}}")
+        end
+      end
+
       # @param [String] key
       # @param [Array<String>] version_strings
       def assign_fixversions(key, version_strings)
@@ -189,6 +224,16 @@ module Apadmi
         @network_service.do_put("/rest/api/2/issue/#{key}", payload)
       end
 
+      # Removes specific fix versions from a ticket using the update.remove operation.
+      # @param [String] key
+      # @param [Array<String>] version_names
+      def remove_fixversions(key, version_names)
+        return if version_names.empty?
+
+        removes = version_names.map { |name| "{\"remove\": {\"name\": \"#{name}\"}}" }.join(", ")
+        @network_service.do_put("/rest/api/2/issue/#{key}", "{\"update\": {\"fixVersions\": [#{removes}]}}")
+      end
+
       # @param [String] key
       # @return [Array<String>]
       def get_ticket_fixversions(key)
@@ -196,6 +241,22 @@ module Apadmi
         JSON.parse(response.body)["fields"]["fixVersions"].map { |v| v["name"] } || []
       end
 
+      # Adds a related work link to a Jira version, skipping if a link with the same URL already exists.
+      # @param [String] version_name
+      # @param [String] url
+      # @param [String] title
+      def add_version_related_work(version_name, url, title)
+        version = all_versions.find { |v| v.name == version_name }
+        raise "Version '#{version_name}' not found" if version.nil?
+
+        response = @network_service.do_get("/rest/api/3/version/#{version.id}/relatedwork")
+        existing_links = JSON.parse(response.body) || []
+        return if existing_links.any? { |link| link["url"] == url }
+
+        payload = { category: "link", url: url, title: title }.to_json
+        @network_service.do_post("/rest/api/3/version/#{version.id}/relatedwork", payload)
+      end
+
       private
 
       # @param [Array<String>] version_strings
@@ -204,11 +265,11 @@ module Apadmi
         all = all_versions
         version_strings.map do |version|
           existing_version = all.find { |v| v.name == version }
-          if !existing_version.nil?
-            existing_version
-          else
+          if existing_version.nil?
             date = Time.now.strftime("%Y-%m-%d")
             create_version(date, version)
+          else
+            existing_version
           end
         end
       end

data/lib/apadmi/grout/utils/command_parsing_utils.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-module AndroidBuildType
-  AAB = "aab"
-  APK = "apk"
-end
-
 module Apadmi
   module Grout
+    module AndroidBuildType
+      AAB = "aab"
+      APK = "apk"
+    end
+
     # Generic Command parsing Utils
     class CommandParsingUtils
       def self.determine_build_type(command)

data/lib/apadmi/grout/utils/git_utils.rb

@@ -10,9 +10,9 @@ module Apadmi
         @repo_path_arg = repo_path.nil? ? "" : " -C #{repo_path} "
       end
 
-      # rubocop:disable Style/ClassVars:
+      # rubocop:disable Style/ClassVars
       @@default = Apadmi::Grout::GitUtils.new(nil)
-      # rubocop:enable Style/ClassVars:
+      # rubocop:enable Style/ClassVars
 
       # Gets the root of the Git repo we're in
       # @return [String] The full path for the root of this Git repo
@@ -103,7 +103,7 @@ module Apadmi
 
       # Helper function to check if a repo is a shallow clone
       # @return [Boolean] If the repo is a shallow clone
-      def is_shallow_clone
+      def is_shallow_clone?
         stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} rev-parse --is-shallow-repository")
         raise "Failed to check if repo is shallow clone: #{stderr}" unless status.success?
 

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "3.0.0.pre"
+    VERSION = "3.0.0.pre3"
   end
 end

data/lib/apadmi_grout.rb

@@ -2,6 +2,6 @@
 
 require "active_support/core_ext/object/blank"
 
-Dir[File.expand_path("apadmi/grout/**/*.rb", File.dirname(__FILE__))].sort.each do |current|
+Dir[File.expand_path("apadmi/grout/**/*.rb", File.dirname(__FILE__))].each do |current|
   require current
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre
+  version: 3.0.0.pre3
 platform: ruby
 authors:
 - Apadmi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-26 00:00:00.000000000 Z
+date: 2026-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday