AutoMerge: Respect the Override AutoMerge: name similarity is okay label (#536)

* respect `Override AutoMerge: name similarity is okay` labels

* update docs & example workflow

* only trigger on the correct label

* add kwargs to docs

* Apply suggestions from code review

Co-authored-by: Dilum Aluthge <[email protected]>

* Update example_github_workflow_files/automerge.yml

Co-authored-by: Dilum Aluthge <[email protected]>

---------

Co-authored-by: Dilum Aluthge <[email protected]>

Author: ericphanson

docs/src/guidelines.md

@@ -22,6 +22,7 @@ function guidelines_to_markdown_output(guidelines_function::Function)
         check_license = true,
         this_is_jll_package = false,
         this_pr_can_use_special_jll_exceptions = false,
+        use_distance_check = false,
     )
     filter!(x -> x[1] != :update_status, guidelines)
     filter!(x -> !(x[1].docs isa Nothing), guidelines)
@@ -50,6 +51,7 @@ function guidelines_to_markdown_output(guidelines_function::Function)
         check_license = true,
         this_is_jll_package = false,
         this_pr_can_use_special_jll_exceptions = false,
+        use_distance_check = false,
     )
     filter!(x -> x[1] != :update_status, guidelines)
     filter!(x -> !(x[1].docs isa Nothing), guidelines)

example_github_workflow_files/automerge.yml

@@ -4,10 +4,19 @@ on:
   schedule:
     - cron: '05,17,29,41,53 * * * *'
   pull_request:
+    # opened = run when the PR is first opened
+    # labeled = run when labels are applied, so that the "Override AutoMerge: name similarity is okay label is respected.
+    # synchronize = run when a commit is pushed to the PR
+    types: [opened, labeled, synchronize]
   workflow_dispatch:
 
 jobs:
   AutoMerge:
+    # Run if the we are not triggered by a label OR we are triggered by a label, and that
+    # label is one that affects the execution of the workflow
+    # Note: since the label contains a colon, we need to use a workaround like https://github.com/actions/runner/issues/1019#issuecomment-810482716
+    # for the syntax to parse correctly.
+    if: "${{ github.event.action != 'labeled' || (github.event.action == 'labeled' && github.event.label.name == 'Override AutoMerge: name similarity is okay') }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:

src/AutoMerge/guidelines.jl

@@ -265,6 +265,8 @@ To prevent confusion between similarly named packages, the names of new packages
       [VisualStringDistances.jl](https://github.com/ericphanson/VisualStringDistances.jl)
       between the package name and any existing package must exceeds a certain
       a hand-chosen threshold (currently 2.5).
+
+These checks can be overridden by applying a label `Override AutoMerge: name similarity is okay` to the PR. This will turn off the check as long as the label is applied to the PR.
   """,
     check=data -> meets_distance_check(data.pkg, data.registry_master),
 )
@@ -373,6 +375,24 @@ function meets_distance_check(
     return (false, message)
 end
 
+# Used in `pull_request_build` to determine if we should
+# perform the distance check or not.
+# We expect to be passed the `labels` field of a PullRequest:
+# <https://github.com/JuliaWeb/GitHub.jl/blob/d24bd6798609ae356db308d65577e99aad0cf432/src/issues/pull_requests.jl#L33>
+function perform_distance_check(labels)
+    # No labels? Do the check
+    isnothing(labels) && return true
+    for label in labels
+        if label.name === "Override AutoMerge: name similarity is okay"
+            # found the override! Skip the check
+            @debug "Found label; skipping distance check" label.name
+            return false
+        end
+    end
+    # Did not find the override. Perform the check.
+    return true
+end
+
 const guideline_normal_capitalization = Guideline(;
     info="Normal capitalization",
     docs=string(
@@ -956,6 +976,7 @@ function get_automerge_guidelines(
     check_license::Bool,
     this_is_jll_package::Bool,
     this_pr_can_use_special_jll_exceptions::Bool,
+    use_distance_check::Bool
 )
     guidelines = [
         (guideline_registry_consistency_tests_pass, true),
@@ -987,7 +1008,7 @@ function get_automerge_guidelines(
         # prints the list of similar package names in
         # the automerge comment. To make the comment easy
         # to read, we want this list to be at the end.
-        (guideline_distance_check, true),
+        (guideline_distance_check, use_distance_check),
     ]
     return guidelines
 end
@@ -997,6 +1018,7 @@ function get_automerge_guidelines(
     check_license::Bool,
     this_is_jll_package::Bool,
     this_pr_can_use_special_jll_exceptions::Bool,
+    use_distance_check::Bool # unused for new versions
 )
     guidelines = [
         (guideline_registry_consistency_tests_pass, true),

src/AutoMerge/pull_requests.jl

@@ -195,6 +195,7 @@ function pull_request_build(data::GitHubAutoMergeData; check_license)::Nothing
         check_license=check_license,
         this_is_jll_package=this_is_jll_package,
         this_pr_can_use_special_jll_exceptions=this_pr_can_use_special_jll_exceptions,
+        use_distance_check=perform_distance_check(data.pr.labels)
     )
     checked_guidelines = Guideline[]
 

test/automerge-unit.jl

@@ -123,6 +123,12 @@ end
             "ReallyLooooongNameCD", ["ReallyLooooongNameAB"]
         )[1]
     end
+    @testset "perform_distance_check" begin
+        @test AutoMerge.perform_distance_check(nothing)
+        @test AutoMerge.perform_distance_check([GitHub.Label(; name="hi")])
+        @test !AutoMerge.perform_distance_check([GitHub.Label(; name="Override AutoMerge: name similarity is okay")])
+        @test !AutoMerge.perform_distance_check([GitHub.Label(; name="hi"), GitHub.Label(; name="Override AutoMerge: name similarity is okay")])
+    end
     @testset "`get_all_non_jll_package_names`" begin
         registry_path = joinpath(DEPOT_PATH[1], "registries", "General")
         packages = AutoMerge.get_all_non_jll_package_names(registry_path)
@@ -617,7 +623,7 @@ end
             @test result[1]
             result = has_osi_license_in_depot("VisualStringDistances")
             @test result[1]
-    
+
             # Now, what happens if there's also a non-OSI license in another file?
             pkg_path = pkgdir_from_depot(tmp_depot, "UnbalancedOptimalTransport")
             open(joinpath(pkg_path, "LICENSE2"); write=true) do io
@@ -627,12 +633,12 @@ end
             end
             result = has_osi_license_in_depot("UnbalancedOptimalTransport")
             @test result[1]
-    
+
             # What if we also remove the original license, leaving only the CC0 license?
             rm(joinpath(pkg_path, "LICENSE"))
             result = has_osi_license_in_depot("UnbalancedOptimalTransport")
             @test !result[1]
-    
+
             # What about no license at all?
             pkg_path = pkgdir_from_depot(tmp_depot, "VisualStringDistances")
             rm(joinpath(pkg_path, "LICENSE"))