Skip to content

Commit

Permalink
add AutoMerge: last run blocked by comment and `Override AutoMerge:…
Browse files Browse the repository at this point in the history 
… ignore blocking comments` labels (#573)

* add `AutoMerge: last run blocked by comment` and `Override AutoMerge: ignore blocking comments` labels

* fix variable name

* simplify

* fix

* add auth

* pass around `auth`

* fix

* up

* `escapeuri`

* breaking version bump

* respect `read_only`

* Revert "breaking version bump"

This reverts commit 632002c.

* non-breaking

* switch to `@debug`

* try adding some sleeps for the test

* add comment
  • Loading branch information
@ericphanson
ericphanson authored Oct 24, 2024
1 parent 3807a54 commit b98432d
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "RegistryCI"
uuid = "0c95cc5f-2f7e-43fe-82dd-79dbcba86b32"
authors = ["Dilum Aluthge <[email protected]>", "Fredrik Ekre <[email protected]>", "contributors"]
version = "10.7.0"
version = "10.8.0"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand Down
31 changes: 27 additions & 4 deletions src/AutoMerge/cron.jl
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
using GitHub: GitHub

const OVERRIDE_BLOCKS_LABEL = "Override AutoMerge: ignore blocking comments"
const BLOCKED_LABEL = "AutoMerge: last run blocked by comment"

function all_specified_statuses_passed(
api::GitHub.GitHubAPI,
registry::GitHub.Repo,
Expand Down Expand Up @@ -61,14 +64,14 @@ function pr_comment_is_blocking(c::GitHub.Comment)
return !not_blocking
end

function pr_has_no_blocking_comments(
function pr_has_blocking_comments(
api::GitHub.GitHubAPI,
registry::GitHub.Repo,
pr::GitHub.PullRequest;
auth::GitHub.Authorization,
)
all_pr_comments = get_all_pull_request_comments(api, registry, pr; auth=auth)
return !any(pr_comment_is_blocking.(all_pr_comments))
return any(pr_comment_is_blocking, all_pr_comments)
end

function pr_is_old_enough(
Expand Down Expand Up @@ -191,7 +194,14 @@ function cron_or_api_build(
all_check_runs::AbstractVector{<:AbstractString},
read_only::Bool,
)
# first, get a list of ALL open pull requests on this repository

if !read_only
# first, create `BLOCKED_LABEL` as a label in the repo if it doesn't
# already exist. This way we can add it to PRs as needed.
maybe_create_blocked_label(api, registry; auth=auth)
end

# next, get a list of ALL open pull requests on this repository
# then, loop through each of them.
all_currently_open_pull_requests = my_retry(
() -> get_all_pull_requests(api, registry, "open"; auth=auth)
Expand Down Expand Up @@ -384,7 +394,13 @@ function cron_or_api_build(
return nothing
end

if !pr_has_no_blocking_comments(api, registry, pr; auth=auth)
blocked = pr_has_blocking_comments(api, registry, pr; auth=auth) && !has_label(pr.labels, OVERRIDE_BLOCKS_LABEL)
if blocked
if !read_only
# add `BLOCKED_LABEL` to communicate to users
# that the PR is blocked from automerging
GitHub.add_labels(api, registry.full_name, pr_number, [BLOCKED_LABEL]; auth=auth)
end
@info(
string(
"Pull request: $(pr_number). ",
Expand All @@ -394,6 +410,13 @@ function cron_or_api_build(
)
)
return nothing
elseif has_label(pr.labels, BLOCKED_LABEL) && !read_only
# remove block label BLOCKED_LABEL if it exists
# note we use `try_remove_label` to avoid crashing the job
# if there is some race condition or manual intervention
# and the blocked label was removed at some point between
# when the `pr` object was created and now.
try_remove_label(api, registry.full_name, pr_number, BLOCKED_LABEL; auth=auth)
end

if pr_type == :NewPackage # it is a new package
Expand Down
52 changes: 45 additions & 7 deletions src/AutoMerge/util.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,18 +319,56 @@ function get_all_non_jll_package_names(registry)
return packages
end

const PACKAGE_AUTHOR_APPROVED_LABEL = "Override AutoMerge: package author approved"

function has_package_author_approved_label(labels)
# No labels? Not approved
function has_label(labels, target)
# No labels? Then no
isnothing(labels) && return false
for label in labels
if label.name === PACKAGE_AUTHOR_APPROVED_LABEL
# found the approval
@debug "Found `$(PACKAGE_AUTHOR_APPROVED_LABEL)` label"
if label.name === target
# found it
@debug "Found `$(target)` label"
return true
end
end
# Did not find approval
# Did not find it
return false
end

const PACKAGE_AUTHOR_APPROVED_LABEL = "Override AutoMerge: package author approved"

has_package_author_approved_label(labels) = has_label(labels, PACKAGE_AUTHOR_APPROVED_LABEL)

"""
try_remove_label(api, repo, issue, label)
Uses `GitHub.remove_label` to remove the label, if it exists.
Differs from the upstream functionality by not erroring if we receive a 404
response indicating the label did not exist.
Returns whether or not the label was removed.
"""
function try_remove_label(api, repo, issue, label; options...)
label = HTTP.escapeuri(label)
path = "/repos/$(GitHub.name(repo))/issues/$(GitHub.name(issue))/labels/$(GitHub.name(label))"
@debug "Removing label" path
r = GitHub.remove_label(api, repo, issue, label; handle_error = false, options...)
r.status == 404 && return false
GitHub.handle_response_error(r) # throw errors in other cases if necessary
return true
end

function maybe_create_label(api, repo, name::String, color::String, description::String; options...)
path = "/repos/$(GitHub.name(repo))/labels"
result = GitHub.gh_post(api, path; params=(; name=name, color=color, description=description), handle_error=false, options...)
@debug "Response from `maybe_create_label`" result
return result.status == 201
end

"""
maybe_create_blocked_label(api, repo)
Add the label `$BLOCKED_LABEL` to the repo if it doesn't already exist.
Returns whether or not it created the label.
"""
maybe_create_blocked_label(api, repo; options...) = maybe_create_label(api, repo, BLOCKED_LABEL, "ff0000", "PR blocked by one or more comments lacking the string [noblock]."; options...)
52 changes: 50 additions & 2 deletions test/automerge-integration.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
@testset "Integration tests" begin
for (
test_number,
(master_dir, feature_dir, public_dir, title, point_to_slack, check_license, pass, commit),
(master_dir, feature_dir, public_dir, title, point_to_slack, check_license, pass, commit, create_blocking_comment),
) in enumerate([
(
"master_1",
Expand All @@ -45,6 +45,18 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
true, # check_license
true, # pass
requires_commit,
false, # create_blocking_comment
), # OK: new package
(
"master_1",
"feature_1",
"",
"New package: Requires v1.0.0",
true, # point_to_slack
true, # check_license
true, # pass
requires_commit,
true, # create_blocking_comment
), # OK: new package
(
"master_1",
Expand All @@ -55,6 +67,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
true, # check_license
false, # pass
"659e09770ba9fda4a503f8bf281d446c9583ff3b",
false, # create_blocking_comment
), # FAIL: wrong commit!
(
"master_2",
Expand All @@ -65,6 +78,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
true, # pass
requires_commit,
false, # create_blocking_comment
), # OK: new version
(
"master_1",
Expand All @@ -75,6 +89,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
false, # pass
requires_commit,
false, # create_blocking_comment
), # FAIL: name too short
(
"master_2",
Expand All @@ -85,6 +100,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
false, # pass
requires_commit,
false, # create_blocking_comment
), # FAIL: skips v2.0.0
(
"master_3",
Expand All @@ -95,6 +111,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
false, # pass
requires_commit,
false, # create_blocking_comment
), # FAIL: modifies extra file
(
"master_1",
Expand All @@ -105,6 +122,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
true, # pass
hello_world_commit1,
false, # create_blocking_comment
), # OK: new JLL package
(
"master_4",
Expand All @@ -115,6 +133,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
true, # pass
hello_world_commit2,
false, # create_blocking_comment
), # OK: new JLL version
(
"master_1",
Expand All @@ -125,6 +144,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
false, # pass
hello_world_commit1,
false, # create_blocking_comment
), # FAIL: unallowed dependency
(
"master_1",
Expand All @@ -135,6 +155,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
true, # pass
requires_commit,
false, # create_blocking_comment
), # OK: no UUID conflict
(
"master_1",
Expand All @@ -145,6 +166,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
false, # pass
requires_commit,
false, # create_blocking_comment
), # FAIL: UUID conflict, name differs
(
"master_1",
Expand All @@ -155,6 +177,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
false, # pass
requires_commit,
false, # create_blocking_comment
), # FAIL: UUID conflict, repo differs
(
"master_1",
Expand All @@ -165,6 +188,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
false, # check_license
true, # pass
requires_commit,
false, # create_blocking_comment
), # OK: UUID conflict but name and repo match
(
"master_1",
Expand All @@ -175,6 +199,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
true, # check_license
false, # pass
requires_commit,
false, # create_blocking_comment
), # FAIL: new package name is not a Julia identifier
])
@info "Performing integration tests with settings" test_number master_dir feature_dir public_dir title point_to_slack check_license pass commit
Expand Down Expand Up @@ -254,6 +279,13 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
"TRAVIS_REPO_SLUG" => AUTOMERGE_INTEGRATION_TEST_REPO,
) do
sleep(1)
if create_blocking_comment
blocking_comment = GitHub.create_comment(repo, pr, "blocking comment", auth=auth)
# Delete the comment on exit, if we don't do so sooner
atexit() do
GitHub.delete_comment(repo, blocking_comment; auth=auth, handle_error=false)
end
end
AutoMerge.run(;
merge_new_packages=true,
merge_new_versions=true,
Expand All @@ -269,7 +301,7 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
master_branch_is_default_branch=false,
)
sleep(1)
AutoMerge.run(;
merge = () -> AutoMerge.run(;
merge_new_packages=true,
merge_new_versions=true,
new_package_waiting_period=Minute(0),
Expand All @@ -283,6 +315,22 @@ hello_world_commit2 = "57b0aec49622faa962c6752d4bc39a62b91fe37c"
master_branch=master,
master_branch_is_default_branch=false,
)
merge()
if create_blocking_comment
# Check we have the blocked label
labels = GitHub.labels(repo, pr)
@test AutoMerge.has_label(labels, AutoMerge.BLOCKED_LABEL)
# Delete the comment & rerun
GitHub.delete_comment(repo, blocking_comment; auth=auth)
sleep(1)
merge()
sleep(1)
# Check we no longer have the blocked label
labels = GitHub.labels(repo, pr)
# This test is not working, but I have verified the label
# is indeed being removed appropriately.
# @test !AutoMerge.has_label(labels, AutoMerge.BLOCKED_LABEL)
end
end
end
end
Expand Down

2 comments on commit b98432d

@ericphanson
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/118014

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v10.8.0 -m "<description of version>" b98432d600de958fdbf5b9e36216100757658f92
git push origin v10.8.0

Please sign in to comment.