Skip to content

Commit

Permalink
Fix guidance if branches (#590)
Browse files Browse the repository at this point in the history
* fix guidance if branches

* patch bump

* update reference tests
  • Loading branch information
IanButterworth authored Dec 18, 2024
1 parent 3dde8c5 commit 9a536fd
Show file tree
Hide file tree
Showing 18 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion Project.toml
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 <dilum@aluthge.com>", "Fredrik Ekre <ekrefredrik@gmail.com>", "contributors"]
version = "10.10.2"
version = "10.10.3"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand Down
4 changes: 2 additions & 2 deletions src/AutoMerge/guidelines.jl
Original file line number Diff line number Diff line change
Expand Up @@ -357,12 +357,12 @@ function breaking_explanation_message(has_release_notes)
"""
if has_release_notes
return """
This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
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.
$(example_detail)
"""
else
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 no release notes have been provided. Please add release notes that explain the breaking change.
$(example_detail)
"""
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please make sure that you have read the [package naming guidelines](https://juli

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -49,7 +49,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Hello, I am an automated registration bot. I help manage the registration proces

</details>

- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
- 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.
<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:
Expand All @@ -45,7 +45,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 no release notes have been provided. Please add release notes that explain the breaking change.
<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:
Expand Down
Loading

2 comments on commit 9a536fd

@IanButterworth
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
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/121635

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.10.3 -m "<description of version>" 9a536fdf4274a5c4351281ae593330ecea6de036
git push origin v10.10.3

Please sign in to comment.