dependabot-github_actions 0.211.0 → 0.213.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a755f2e216dc49388866fbceae4209313b2272d243691b331793313ab8842b8
-  data.tar.gz: 15b4dec7f68b942709c3c260ffaeea6dd3fad49bf90e88b4189fca41da4bdc9e
+  metadata.gz: e40718bacbd579d5f066f1951840b92e43e2a4f9d18d35870b02e6cf43352a3d
+  data.tar.gz: df27ec63cc58ce499478d5d89f35f57b5d171a4cbc3487025e560efe6c4c8219
 SHA512:
-  metadata.gz: 775c9fdb7b9090cd939ac0f23610403abe2cfd6da3bf8f602f2e5069d83ce532d68546af2571d31725b50c8736bfa966aeb363f160c4e1fddd224337fe021b53
-  data.tar.gz: c972c2410a628a3a1a83c114652096a1112bd1e0aa830cbed9302a79322e4728b6a2a5d351bce5f224cea9e88dfa3719d5e9953d44f44d3f9e45f2978fb65355
+  metadata.gz: 855575e94d06e5749ee006e0a20180c8de9bbdb519b9adb894ac4cd943aaa2c852c1714a92a44ed4e6c7736c64cb9c74af5824825fdc2dd57e0977aee3dcfd6f
+  data.tar.gz: 8bca4abb38782199a213843eb76a8ffddb204db1d3e68ed1310a794d0893d1f8545e62cf64cfbea87fd62174ffa8af3d3661ff3c646f2540864a2cb49bfa396e

data/lib/dependabot/github_actions/file_fetcher.rb

@@ -6,7 +6,7 @@ require "dependabot/file_fetchers/base"
 module Dependabot
   module GithubActions
     class FileFetcher < Dependabot::FileFetchers::Base
-      FILENAME_PATTERN = /^(\.github|action.ya?ml)$/.freeze
+      FILENAME_PATTERN = /^(\.github|action.ya?ml)$/
 
       def self.required_files_in?(filenames)
         filenames.any? { |f| f.match?(FILENAME_PATTERN) }

data/lib/dependabot/github_actions/file_parser.rb

@@ -21,7 +21,7 @@ module Dependabot
         (?<repo>[\w.-]+)
         (?<path>/[^\@]+)?
         @(?<ref>.+)
-      }x.freeze
+      }x
 
       def parse
         dependency_set = DependencySet.new
@@ -109,7 +109,7 @@ module Dependabot
         steps = json_object.fetch("steps", [])
 
         uses_strings =
-          if steps.is_a?(Array) && steps.all? { |s| s.is_a?(Hash) }
+          if steps.is_a?(Array) && steps.all?(Hash)
             steps.
               map { |step| step.fetch("uses", nil) }.
               select { |use| use.is_a?(String) }

data/lib/dependabot/github_actions/file_updater.rb

@@ -65,17 +65,41 @@ module Dependabot
             gsub(/@.*+/, "@#{new_req.fetch(:source).fetch(:ref)}")
 
           # Replace the old declaration that's preceded by a non-word character
-          # and followed by a whitespace character (comments) or EOL
+          # and followed by a whitespace character (comments) or EOL.
+          # If the declaration is followed by a comment that lists the version associated
+          # with the SHA source ref, then update the comment to the human-readable new version.
+          # However, if the comment includes additional text beyond the version, for safety
+          # we skip updating the comment in case it's a custom note, todo, warning etc of some kind.
+          # See the related unit tests for examples.
           updated_content =
             updated_content.
             gsub(
-              /(?<=\W|"|')#{Regexp.escape(old_declaration)}(?=\s|"|'|$)/,
-              new_declaration
-            )
+              /(?<=\W|"|')#{Regexp.escape(old_declaration)}(?<comment>\s+#.*)?(?=\s|"|'|$)/
+            ) do |match|
+              comment = Regexp.last_match(:comment)
+              match.gsub!(old_declaration, new_declaration)
+              if comment && (updated_comment = updated_version_comment(comment, new_req))
+                match.gsub!(comment, updated_comment)
+              end
+              match
+            end
         end
 
         updated_content
       end
+
+      def updated_version_comment(comment, new_req)
+        raise "No comment!" unless comment
+
+        comment = comment.rstrip
+        return unless dependency.previous_version && dependency.version
+        return unless comment.end_with? dependency.previous_version
+
+        git_checker = Dependabot::GitCommitChecker.new(dependency: dependency, credentials: credentials)
+        return unless git_checker.ref_looks_like_commit_sha?(new_req.fetch(:source).fetch(:ref))
+
+        comment.gsub(dependency.previous_version, dependency.version)
+      end
     end
   end
 end

data/lib/dependabot/github_actions/metadata_finder.rb

@@ -9,7 +9,7 @@ module Dependabot
       private
 
       def look_up_source
-        info = dependency.requirements.map { |r| r[:source] }.compact.first
+        info = dependency.requirements.filter_map { |r| r[:source] }.first
 
         url =
           if info.nil?

data/lib/dependabot/github_actions/requirement.rb

@@ -7,7 +7,7 @@ module Dependabot
   module GithubActions
     # Lifted from the bundler package manager
     class Requirement < Gem::Requirement
-      # For consistency with other langauges, we define a requirements array.
+      # For consistency with other languages, we define a requirements array.
       # Ruby doesn't have an `OR` separator for requirements, so it always
       # contains a single element.
       def self.requirements_array(requirement_string)

data/lib/dependabot/github_actions/update_checker.rb

@@ -59,7 +59,7 @@ module Dependabot
       end
 
       def fetch_latest_version_for_git_dependency
-        return git_commit_checker.head_commit_for_current_branch unless git_commit_checker.pinned?
+        return current_commit unless git_commit_checker.pinned?
 
         # If the dependency is pinned to a tag that looks like a version then
         # we want to update that tag.
@@ -70,11 +70,11 @@ module Dependabot
           return latest_version
         end
 
-        # If the dependency is pinned to a commit SHA, we return a *version* so
-        # that we get nice behaviour in PullRequestCreator::MessageBuilder
-        if git_commit_checker.pinned_ref_looks_like_commit_sha?
-          latest_tag = git_commit_checker.local_tag_for_latest_version
-          return latest_tag.fetch(:version)
+        if git_commit_checker.pinned_ref_looks_like_commit_sha? && latest_version_tag
+          latest_version = latest_version_tag.fetch(:version)
+          return latest_commit_for_pinned_ref unless git_commit_checker.branch_or_ref_in_release?(latest_version)
+
+          return latest_version
         end
 
         # If the dependency is pinned to a tag that doesn't look like a
@@ -82,6 +82,15 @@ module Dependabot
         nil
       end
 
+      def latest_commit_for_pinned_ref
+        @latest_commit_for_pinned_ref ||=
+          SharedHelpers.in_a_temporary_repo_directory("/", repo_contents_path) do
+            ref_branch = find_container_branch(current_commit)
+
+            git_commit_checker.head_commit_for_local_branch(ref_branch)
+          end
+      end
+
       def latest_version_tag
         @latest_version_tag ||= begin
           return git_commit_checker.local_tag_for_latest_version if dependency.version.nil?
@@ -89,25 +98,15 @@ module Dependabot
           latest_tags = git_commit_checker.local_tags_for_latest_version_commit_sha
 
           # Find the latest version with the same precision as the pinned version.
-          # Falls back to a version with the closest precision if no exact match.
-          current_dots = dependency.version.split(".").length
-          latest_tags.max do |a, b|
-            next a[:version] <=> b[:version] unless shortened_semver_version_eq?(a[:version], b[:version])
-
-            a_dots = a[:version].to_s.split(".").length
-            b_dots = b[:version].to_s.split(".").length
-            a_diff = (a_dots - current_dots).abs
-            b_diff = (b_dots - current_dots).abs
-            next -(a_diff <=> b_diff) unless a_diff == b_diff
-
-            # preference to a less specific version if we have a tie
-            next 1 if a_dots < current_dots
-
-            -1
-          end
+          current_precision = precision(dependency.version)
+          latest_tags.select { |tag| precision(tag[:version].to_s) == current_precision }.max_by { |tag| tag[:version] }
         end
       end
 
+      def precision(version)
+        version.split(".").length
+      end
+
       def updated_source
         # TODO: Support Docker sources
         return dependency_source_details unless git_dependency?
@@ -119,18 +118,28 @@ module Dependabot
           return dependency_source_details.merge(ref: new_tag.fetch(:tag))
         end
 
-        latest_tag = git_commit_checker.local_tag_for_latest_version
-
         # Update the pinned git commit if one is available
         if git_commit_checker.pinned_ref_looks_like_commit_sha? &&
-           latest_tag.fetch(:commit_sha) != current_commit
-          return dependency_source_details.merge(ref: latest_tag.fetch(:commit_sha))
+           (new_commit_sha = latest_commit_sha) &&
+           new_commit_sha != current_commit
+          return dependency_source_details.merge(ref: new_commit_sha)
         end
 
         # Otherwise return the original source
         dependency_source_details
       end
 
+      def latest_commit_sha
+        new_tag = latest_version_tag
+        return unless new_tag
+
+        if git_commit_checker.branch_or_ref_in_release?(new_tag.fetch(:version))
+          new_tag.fetch(:commit_sha)
+        else
+          latest_commit_for_pinned_ref
+        end
+      end
+
       def dependency_source_details
         sources =
           dependency.requirements.map { |r| r.fetch(:source) }.uniq.compact
@@ -174,11 +183,21 @@ module Dependabot
         other_split[0..base_split.length - 1] == base_split
       end
 
-      def shortened_semver_version_eq?(base_version, other_version)
-        base = base_version.to_s
-        other = other_version.to_s
+      def find_container_branch(sha)
+        SharedHelpers.run_shell_command("git fetch #{current_commit}")
+
+        branches_including_ref = SharedHelpers.run_shell_command("git branch --contains #{sha}").split("\n")
 
-        shortened_semver_eq?(base, other) || shortened_semver_eq?(other, base)
+        current_branch = branches_including_ref.find { |line| line.start_with?("* ") }
+
+        if current_branch
+          current_branch.delete_prefix("* ")
+        elsif branches_including_ref.size > 1
+          # If there are multiple non default branches including the pinned SHA, then it's unclear how we should proceed
+          raise "Multiple ambiguous branches (#{branches_including_ref.join(', ')}) include #{current_commit}!"
+        else
+          branches_including_ref.first
+        end
       end
     end
   end

data/lib/dependabot/github_actions/version.rb

@@ -13,7 +13,7 @@ module Dependabot
       def self.remove_leading_v(version)
         return version unless version.to_s.match?(/\Av([0-9])/)
 
-        version.to_s.gsub(/\Av/, "")
+        version.to_s.delete_prefix("v")
       end
 
       def self.correct?(version)

data/lib/dependabot/github_actions.rb

@@ -22,3 +22,6 @@ Dependabot::PullRequestCreator::Labeler.
 require "dependabot/dependency"
 Dependabot::Dependency.
   register_production_check("github_actions", ->(_) { true })
+
+require "dependabot/utils"
+Dependabot::Utils.register_always_clone("github_actions")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-github_actions
 version: !ruby/object:Gem::Version
-  version: 0.211.0
+  version: 0.213.0
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dependabot-common
@@ -16,42 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.211.0
+        version: 0.213.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.211.0
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.2.3
-- !ruby/object:Gem::Dependency
-  name: debase-ruby_core_source
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.10.16
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.10.16
+        version: 0.213.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.1
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.1
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.35.1
+        version: 1.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.35.1
+        version: 1.37.1
 - !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -261,14 +233,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: GitHub Actions support for dependabot-common