improve comment actionability (#561)

JuliaRegistries · Jun 13, 2024 · 86cdd37 · 86cdd37 · ericphanson · Jun 13, 2024
1 parent 350a4cf
commit 86cdd37
Show file tree

Hide file tree

Showing 34 changed files with 83 additions and 83 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "RegistryCI"
 uuid = "0c95cc5f-2f7e-43fe-82dd-79dbcba86b32"
 authors = ["Dilum Aluthge <[email protected]>", "Fredrik Ekre <[email protected]>", "contributors"]
-version = "10.2.0"
+version = "10.3.0"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

diff --git a/src/AutoMerge/util.jl b/src/AutoMerge/util.jl
@@ -112,7 +112,7 @@ end
 
 function _what_next_if_fail(n; point_to_slack=false)
     msg = """
-    ## $n. What to do next
+    ## $n. *Needs action*: here's what to do next
 
     1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`)"""
     if point_to_slack
@@ -131,11 +131,11 @@ function _what_next_if_fail(n; point_to_slack=false)
 end
 
 function _automerge_guidelines_failed_section_title(n)
-    return "## $n. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met\n\n"
+    return "## $n. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌\n\n"
 end
 
 function _automerge_guidelines_passed_section_title(n)
-    "## $n. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) are all met!\n\n"
+    "## $n. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) are all met! ✅\n\n"
 end
 
 function _comment_noblock(n)

diff --git a/...pe_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md b/...pe_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`)
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).

diff --git a/...ype_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md b/...ype_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`) or send a message to the `#pkg-registration` channel in the [public Julia Slack](https://julialang.org/slack/) to ask for help. Include a link to this pull request if you do so!
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -21,4 +21,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...pe_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md b/...pe_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`)
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -21,4 +21,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...ype_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md b/...ype_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`) or send a message to the `#pkg-registration` channel in the [public Julia Slack](https://julialang.org/slack/) to ask for help. Include a link to this pull request if you do so!
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -21,4 +21,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...ype_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md b/...ype_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`)
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -29,4 +29,4 @@ If your package does not yet have a stable public API, then of course you are no
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md b/...type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`) or send a message to the `#pkg-registration` channel in the [public Julia Slack](https://julialang.org/slack/) to ask for help. Include a link to this pull request if you do so!
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -29,4 +29,4 @@ If your package does not yet have a stable public API, then of course you are no
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...ype_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md b/...ype_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`)
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -21,4 +21,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md b/...type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md
@@ -6,11 +6,11 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
 Since you are registering a new package, please make sure that you have read the [package naming guidelines](https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1).
 
-## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 3. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 4. What to do next
+## 4. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`) or send a message to the `#pkg-registration` channel in the [public Julia Slack](https://julialang.org/slack/) to ask for help. Include a link to this pull request if you do so!
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -21,4 +21,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...pe_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md b/...pe_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md
@@ -2,11 +2,11 @@
 
 Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of [AutoMerge guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/). Meeting these guidelines is only required for the pull request to be **merged automatically**. However, it is **strongly recommended** to follow them, since otherwise the pull request needs to be manually reviewed and merged by a human.
 
-## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 3. What to do next
+## 3. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`)
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -17,4 +17,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->
diff --git a/...ype_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md b/...ype_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md
@@ -2,11 +2,11 @@
 
 Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of [AutoMerge guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/). Meeting these guidelines is only required for the pull request to be **merged automatically**. However, it is **strongly recommended** to follow them, since otherwise the pull request needs to be manually reviewed and merged by a human.
 
-## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met
+## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌
 
 - Example guideline failed. Please fix it.
 
-## 3. What to do next
+## 3. *Needs action*: here's what to do next
 
 1. Please try to update your package to conform to these guidelines. The [General registry's README](https://github.com/JuliaRegistries/General/blob/master/README.md) has an FAQ that can help figure out how to do so. You can also leave a comment on this PR (and include `[noblock]`) or send a message to the `#pkg-registration` channel in the [public Julia Slack](https://julialang.org/slack/) to ask for help. Include a link to this pull request if you do so!
 2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your `Project.toml` file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).
@@ -17,4 +17,4 @@ If you do not want to fix the AutoMerge issues, please post a comment explaining
 
 If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text `[noblock]` in your comment. You can edit blocking comments, adding `[noblock]` to them in order to unblock auto-merging.
 
-<!-- [noblock] -->
+<!-- [noblock] -->