Improve automerge error message for breaking changes (#596)

* Improve automerge error message for breaking changes

* shorten message

* bump version

* update reference tests

Author: ericphanson

Project.toml

@@ -1,7 +1,7 @@
 name = "RegistryCI"
 uuid = "0c95cc5f-2f7e-43fe-82dd-79dbcba86b32"
 authors = ["Dilum Aluthge <dilum@aluthge.com>", "Fredrik Ekre <ekrefredrik@gmail.com>", "contributors"]
-version = "10.10.3"
+version = "10.10.4"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

src/AutoMerge/guidelines.jl

@@ -353,11 +353,13 @@ function breaking_explanation_message(has_release_notes)
         ```
 
         If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+        Either way, you need to mention the words \"breaking\" or \"changelog\", even if it is just to say "there are no breaking changes", or "see the changelog".
         </details>
     """
     if has_release_notes
         return """
-        This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+        This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words \"breaking\" or \"changelog\").
         $(example_detail)
         """
     else

test/automerge-unit.jl

@@ -49,6 +49,7 @@ strip_equal(x, y) = strip(x) == strip(y)
 
 # Here we reference test all the permutations of the AutoMerge comments.
 # This allows us to see the diffs in PRs that change the AutoMerge comment.
+# You can set `ENV["JULIA_REFERENCETESTS_UPDATE"] = true` to easily update the reference tests.
 function comment_reference_test()
     for pass in (true, false),
         (type_name,type) in (("new_version", AutoMerge.NewVersion()), ("new_package", AutoMerge.NewPackage())),

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md

@@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -46,6 +46,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -66,6 +68,8 @@ Please make sure that you have read the [package naming guidelines](https://juli
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md

@@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -42,6 +42,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -62,6 +64,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md

@@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -42,6 +42,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -62,6 +64,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md

@@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -42,6 +42,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -62,6 +64,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 

test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md

@@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces
 
     </details>
 
-- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes.
+- This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").
     <details><summary>Example of adding release notes with breaking notice</summary>
 
     If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes:
@@ -42,6 +42,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>
 
 
@@ -62,6 +64,8 @@ Hello, I am an automated registration bot. I help manage the registration proces
     ```
 
     If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.
+
+    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".
     </details>