From 6f3de32a880504b39831ad58e6454a27bfd05b07 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 09:45:39 -0500 Subject: [PATCH 01/15] add requirement and detection that breaking changes are explained in release notes --- docs/src/guidelines.md | 22 ++++++++++++++++++++++ src/AutoMerge/guidelines.jl | 28 ++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/docs/src/guidelines.md b/docs/src/guidelines.md index a97dc3ec..d8c2bd3c 100644 --- a/docs/src/guidelines.md +++ b/docs/src/guidelines.md @@ -130,6 +130,28 @@ very possible for a perfectly good name to not pass the automatic checks and require manual merging. They simply exist to provide a fast path so that manual review is not required for every new package. +### Providing and updating release notes + +When invoking a registration with the `@JuliaRegister` bot, release notes can be added in the form +``` +@JuliaRegistrator register + +Release notes: + +## Breaking changes + +- Explanation of breaking change, ideally with upgrade tips +- ... +``` + +These can also be added/updated on the General PR by re-invoking with the above. + +Doing this has two benefits: + - helps explanations during the registration process, especially for breaking changes + - release notes are picked up by TagBot such that they are added to the new release on the orignial repo + +Automerge is disabled for breaking changes where release notes are not provided mentioning "breaking". + ## List of all GitHub PR labels that can influence AutoMerge AutoMerge reads certain labels on GitHub registration pull requests to influence its decisions. diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index 3eb24efe..e5e93861 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -322,6 +322,32 @@ function meets_name_match_check( return (true, "") end +# This check checks for an explanation of why a breaking change is breaking +const guideline_breaking_explanation = Guideline(; + info = "Release notes have not been provided that explain why this is a breaking change.", + docs = "If this is a breaking change, release notes must be given that explain why this is a breaking change (i.e. mention \"breaking\"). To update the release notes, please see the \"Providing and updating release notes\" subsection under \"Additional information\" below.", + check=data -> meets_breaking_explanation_check(data.pr.labels, data.pr.body)) + +function meets_breaking_explanation_check(labels, body) + if any(==("BREAKING"), labels) + release_notes = get_release_notes(body) + if release_notes === nothing + return false, "This is a breaking change, but no release notes have been provided." + elseif !occursin(r"breaking", lowercase(release_notes)) + return false, "This is a breaking change, but the release notes do not mention it." + else + return true, "" + end + else + return true, "" + end +end + +function get_release_notes(body::AbstractString) + pattern = r"\s*(.*?)\s*" + return findfirst(pattern, body) +end + # This check looks for similar (but not exactly matching) names. It can be # overridden by a label. @@ -1078,6 +1104,7 @@ function get_automerge_guidelines( this_is_jll_package::Bool, this_pr_can_use_special_jll_exceptions::Bool, use_distance_check::Bool, + use_breaking_explanation_check::Bool = !this_is_jll_package, package_author_approved::Bool # currently unused for new packages ) guidelines = [ @@ -1111,6 +1138,7 @@ function get_automerge_guidelines( (guideline_dependency_confusion, true), # this is the non-optional part of name checking (guideline_name_match_check, true), + (guideline_breaking_explanation, use_breaking_explanation_check), # We always run the `guideline_distance_check` # check last, because if the check fails, it # prints the list of similar package names in From 5f96d9fc6a637e9b35536a22be3a4e2eff382c75 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 10:19:31 -0500 Subject: [PATCH 02/15] add unit tests --- test/automerge-unit.jl | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/test/automerge-unit.jl b/test/automerge-unit.jl index 230bdced..a9b278a3 100644 --- a/test/automerge-unit.jl +++ b/test/automerge-unit.jl @@ -321,6 +321,35 @@ end @test !AutoMerge.range_did_not_narrow(r2, r3)[1] @test !AutoMerge.range_did_not_narrow(r3, r2)[1] end + + @testset "Breaking change releases must have explanatory release notes" begin + body_good = """ + + ````` + ## Breaking changes + - something + - something else + ````` + + """ + body_bad = """ + + ````` + ## Features + - something + - something else + ````` + + """ + body_bad_no_notes = "" + + @test AutoMerge.meets_breaking_explanation_check(["BREAKING"], body_good)[1] + @test !AutoMerge.meets_breaking_explanation_check(["BREAKING"], body_bad)[1] + @test !AutoMerge.meets_breaking_explanation_check(["BREAKING"], body_bad_no_notes)[1] + + # Maybe this should fail as the label isn't applied by JuliaRegistrator, so the version isn't breaking? + @test AutoMerge.meets_breaking_explanation_check([], body_good)[1] + end end @testset "Guidelines for both new packages and new versions" begin From 1efe91553b418b534acab057536403b2b7630b4c Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 10:36:51 -0500 Subject: [PATCH 03/15] fix get_release_notes --- src/AutoMerge/guidelines.jl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index e5e93861..a1a6267e 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -344,11 +344,11 @@ function meets_breaking_explanation_check(labels, body) end function get_release_notes(body::AbstractString) - pattern = r"\s*(.*?)\s*" - return findfirst(pattern, body) + pattern = r"(?s)(.*?)" + m = match(pattern, body) + return m === nothing ? nothing : m.captures[1] end - # This check looks for similar (but not exactly matching) names. It can be # overridden by a label. const guideline_distance_check = Guideline(; From d69dfb3395c7c95471ec9403dde5647510b65cee Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 16:29:46 +0000 Subject: [PATCH 04/15] look up the PR at guideline check time to protect against slow labelling --- src/AutoMerge/guidelines.jl | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index a1a6267e..d902e7b9 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -326,11 +326,14 @@ end const guideline_breaking_explanation = Guideline(; info = "Release notes have not been provided that explain why this is a breaking change.", docs = "If this is a breaking change, release notes must be given that explain why this is a breaking change (i.e. mention \"breaking\"). To update the release notes, please see the \"Providing and updating release notes\" subsection under \"Additional information\" below.", - check=data -> meets_breaking_explanation_check(data.pr.labels, data.pr.body)) - -function meets_breaking_explanation_check(labels, body) - if any(==("BREAKING"), labels) - release_notes = get_release_notes(body) + check=data -> meets_breaking_explanation_check(data)) + +function meets_breaking_explanation_check(data) + # Look up PR here in case the labels are slow to be applied by the Registrator bot + # which decides wheter to add the BREAKING label + pr = GitHub.pull_request(data.api, data.registry, data.pr.number; auth=data.auth) + if any(==("BREAKING"), pr.labels) + release_notes = get_release_notes(pr.body) if release_notes === nothing return false, "This is a breaking change, but no release notes have been provided." elseif !occursin(r"breaking", lowercase(release_notes)) From 01acb650588a2a840d778fa1b9035d1fbc479ee2 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 16:45:32 +0000 Subject: [PATCH 05/15] Update src/AutoMerge/guidelines.jl Co-authored-by: Eric Hanson <5846501+ericphanson@users.noreply.github.com> --- src/AutoMerge/guidelines.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index d902e7b9..f8aaf2c2 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -330,7 +330,7 @@ const guideline_breaking_explanation = Guideline(; function meets_breaking_explanation_check(data) # Look up PR here in case the labels are slow to be applied by the Registrator bot - # which decides wheter to add the BREAKING label + # which decides whether to add the BREAKING label pr = GitHub.pull_request(data.api, data.registry, data.pr.number; auth=data.auth) if any(==("BREAKING"), pr.labels) release_notes = get_release_notes(pr.body) From ee66e918c93e7c0b24324c1957d9014ebb874578 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 16:48:07 +0000 Subject: [PATCH 06/15] accommodate unit tests --- src/AutoMerge/guidelines.jl | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index f8aaf2c2..bd4a10e4 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -328,12 +328,15 @@ const guideline_breaking_explanation = Guideline(; docs = "If this is a breaking change, release notes must be given that explain why this is a breaking change (i.e. mention \"breaking\"). To update the release notes, please see the \"Providing and updating release notes\" subsection under \"Additional information\" below.", check=data -> meets_breaking_explanation_check(data)) -function meets_breaking_explanation_check(data) +function meets_breaking_explanation_check(data::GitHubAutoMergeData) # Look up PR here in case the labels are slow to be applied by the Registrator bot # which decides whether to add the BREAKING label pr = GitHub.pull_request(data.api, data.registry, data.pr.number; auth=data.auth) - if any(==("BREAKING"), pr.labels) - release_notes = get_release_notes(pr.body) + return meets_breaking_explanation_check(pr.labels, pr.body) +end +function meets_breaking_explanation_check(labels::Vector, body::AbstractString) + if any(==("BREAKING"), labels) + release_notes = get_release_notes(body) if release_notes === nothing return false, "This is a breaking change, but no release notes have been provided." elseif !occursin(r"breaking", lowercase(release_notes)) From aced3e7ff66f0391704387cc3035937dc2d1924f Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 17:17:02 +0000 Subject: [PATCH 07/15] make it opt-in in `run` --- example_github_workflow_files/automerge.yml | 2 +- src/AutoMerge/guidelines.jl | 4 ++-- src/AutoMerge/public.jl | 4 ++++ src/AutoMerge/pull_requests.jl | 6 ++++-- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/example_github_workflow_files/automerge.yml b/example_github_workflow_files/automerge.yml index 79aea526..73a5db06 100644 --- a/example_github_workflow_files/automerge.yml +++ b/example_github_workflow_files/automerge.yml @@ -35,4 +35,4 @@ jobs: AUTOMERGE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} AUTOMERGE_TAGBOT_TOKEN: ${{ secrets.TAGBOT_TOKEN }} JULIA_DEBUG: RegistryCI,AutoMerge - run: julia --project=.ci/ -e 'using RegistryCI; using Dates; RegistryCI.AutoMerge.run(merge_new_packages = true, merge_new_versions = true, new_package_waiting_period = Day(3), new_jll_package_waiting_period = Minute(15), new_version_waiting_period = Minute(15), new_jll_version_waiting_period = Minute(15), registry = "JuliaRegistries/General", tagbot_enabled=true, authorized_authors = String["JuliaRegistrator"], authorized_authors_special_jll_exceptions = String["jlbuild"], suggest_onepointzero = false, additional_statuses = String[], additional_check_runs = String["Travis CI - Pull Request"])' + run: julia --project=.ci/ -e 'using RegistryCI; using Dates; RegistryCI.AutoMerge.run(merge_new_packages = true, merge_new_versions = true, new_package_waiting_period = Day(3), new_jll_package_waiting_period = Minute(15), new_version_waiting_period = Minute(15), new_jll_version_waiting_period = Minute(15), registry = "JuliaRegistries/General", tagbot_enabled=true, authorized_authors = String["JuliaRegistrator"], authorized_authors_special_jll_exceptions = String["jlbuild"], suggest_onepointzero = false, additional_statuses = String[], additional_check_runs = String["Travis CI - Pull Request"], check_breaking_explanation = true)' diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index bd4a10e4..73cdb6d4 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -1110,7 +1110,6 @@ function get_automerge_guidelines( this_is_jll_package::Bool, this_pr_can_use_special_jll_exceptions::Bool, use_distance_check::Bool, - use_breaking_explanation_check::Bool = !this_is_jll_package, package_author_approved::Bool # currently unused for new packages ) guidelines = [ @@ -1144,7 +1143,6 @@ function get_automerge_guidelines( (guideline_dependency_confusion, true), # this is the non-optional part of name checking (guideline_name_match_check, true), - (guideline_breaking_explanation, use_breaking_explanation_check), # We always run the `guideline_distance_check` # check last, because if the check fails, it # prints the list of similar package names in @@ -1158,6 +1156,7 @@ end function get_automerge_guidelines( ::NewVersion; check_license::Bool, + check_breaking_explanation::Bool, this_is_jll_package::Bool, this_pr_can_use_special_jll_exceptions::Bool, use_distance_check::Bool, # unused for new versions @@ -1185,6 +1184,7 @@ function get_automerge_guidelines( (guideline_version_has_osi_license, check_license), (guideline_src_names_OK, true), (guideline_version_can_be_imported, true), + (guideline_breaking_explanation, check_breaking_explanation && !this_is_jll_package), ] return guidelines end diff --git a/src/AutoMerge/public.jl b/src/AutoMerge/public.jl index f759fe27..86ab7be1 100644 --- a/src/AutoMerge/public.jl +++ b/src/AutoMerge/public.jl @@ -31,6 +31,7 @@ Run the `RegistryCI.AutoMerge` service. - `registry_deps`: list of registry dependencies, e.g your packages may depend on `General`. - `api_url`: the registry host API URL, default is `"https://api.github.com"`. - `check_license`: check package has a valid license, default is `false`. +- `check_breaking_explanation`: Check whether the PR has release notes (collected via Registrator.jl) with a breaking change explanation, default is `false`. - `public_registries`: If a new package registration has a UUID that matches that of a package already registered in one of these registries supplied here (and has either a different name or different URL) then an error will be thrown. @@ -62,6 +63,7 @@ RegistryCI.AutoMerge.run( additional_statuses = String[], additional_check_runs = String[], check_license = true, + check_breaking_explanation = true, public_registries = String["https://github.com/HolyLab/HolyLabRegistry"], ) ``` @@ -95,6 +97,7 @@ function run(; registry_deps::Vector{<:AbstractString}=String[], api_url::String="https://api.github.com", check_license::Bool=false, + check_breaking_explanation::Bool=false, # A list of public Julia registries (repository URLs) # which will be checked for UUID collisions in order to # mitigate the dependency confusion vulnerability. See @@ -158,6 +161,7 @@ function run(; whoami=whoami, registry_deps=registry_deps, check_license=check_license, + check_breaking_explanation=check_breaking_explanation, public_registries=public_registries, read_only=read_only, environment_variables_to_pass=environment_variables_to_pass, diff --git a/src/AutoMerge/pull_requests.jl b/src/AutoMerge/pull_requests.jl index 7b7c9506..6c972538 100644 --- a/src/AutoMerge/pull_requests.jl +++ b/src/AutoMerge/pull_requests.jl @@ -86,6 +86,7 @@ function pull_request_build( point_to_slack::Bool, registry_deps::Vector{<:AbstractString}=String[], check_license::Bool, + check_breaking_explanation::Bool, public_registries::Vector{<:AbstractString}=String[], read_only::Bool, environment_variables_to_pass::Vector{<:AbstractString}=String[], @@ -166,12 +167,12 @@ function pull_request_build( read_only=read_only, environment_variables_to_pass=environment_variables_to_pass, ) - pull_request_build(data; check_license=check_license, new_package_waiting_period=new_package_waiting_period) + pull_request_build(data; check_license=check_license, check_breaking_explanation=check_breaking_explanation, new_package_waiting_period=new_package_waiting_period) rm(registry_master; force=true, recursive=true) return nothing end -function pull_request_build(data::GitHubAutoMergeData; check_license, new_package_waiting_period)::Nothing +function pull_request_build(data::GitHubAutoMergeData; check_license, check_breaking_explanation, new_package_waiting_period)::Nothing kind = package_or_version(data.registration_type) this_is_jll_package = is_jll_name(data.pkg) @info( @@ -194,6 +195,7 @@ function pull_request_build(data::GitHubAutoMergeData; check_license, new_packag guidelines = get_automerge_guidelines( data.registration_type; check_license=check_license, + check_breaking_explanation=check_breaking_explanation, 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), From cc865901ac8abbc5f4edb90ba9ed250a06c3092f Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 17:20:49 +0000 Subject: [PATCH 08/15] tryfix --- docs/src/guidelines.md | 2 ++ docs/src/private-registries.md | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/src/guidelines.md b/docs/src/guidelines.md index d8c2bd3c..af128fe7 100644 --- a/docs/src/guidelines.md +++ b/docs/src/guidelines.md @@ -20,6 +20,7 @@ function guidelines_to_markdown_output(guidelines_function::Function) guidelines = guidelines_function( registration_type; check_license = true, + check_breaking_explanation = true, this_is_jll_package = false, this_pr_can_use_special_jll_exceptions = false, use_distance_check = false, @@ -50,6 +51,7 @@ function guidelines_to_markdown_output(guidelines_function::Function) guidelines = guidelines_function( registration_type; check_license = true, + check_breaking_explanation = true, this_is_jll_package = false, this_pr_can_use_special_jll_exceptions = false, use_distance_check = false, diff --git a/docs/src/private-registries.md b/docs/src/private-registries.md index ae8d17d6..a09eec4a 100644 --- a/docs/src/private-registries.md +++ b/docs/src/private-registries.md @@ -73,6 +73,7 @@ RegistryCI.AutoMerge.run( additional_statuses = String[], additional_check_runs = String[], check_license = true, + check_breaking_explanation = true, public_registries = String["https://github.com/HolyLab/HolyLabRegistry"], ) ``` From f74fef6646903b00992b10a7b9e98f123c4762f9 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 17:30:26 +0000 Subject: [PATCH 09/15] fix --- src/AutoMerge/guidelines.jl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index 73cdb6d4..7806441f 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -1110,7 +1110,8 @@ function get_automerge_guidelines( this_is_jll_package::Bool, this_pr_can_use_special_jll_exceptions::Bool, use_distance_check::Bool, - package_author_approved::Bool # currently unused for new packages + package_author_approved::Bool, # currently unused for new packages + check_breaking_explanation::Bool # not valid for new packages ) guidelines = [ # We first verify the name is a valid Julia identifier. From 241cabe0b11432b3d0dd7181213435371e0d93e4 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 18:20:21 +0000 Subject: [PATCH 10/15] expand message with example --- src/AutoMerge/guidelines.jl | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index 7806441f..abf37552 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -337,10 +337,35 @@ end function meets_breaking_explanation_check(labels::Vector, body::AbstractString) if any(==("BREAKING"), labels) release_notes = get_release_notes(body) + example_detail = """ +
Example of adding release notes with breaking notice + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` +
+ """ if release_notes === nothing return false, "This is a breaking change, but no release notes have been provided." + msg = """ + This is a breaking change, but no release notes have been provided. + Please add releas notes that explain the breaking change. + $(example_detail) + """ + return false, msg elseif !occursin(r"breaking", lowercase(release_notes)) - return false, "This is a breaking change, but the release notes do not mention it." + msg = """ + 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) + """ + return false, msg else return true, "" end From 2704f9cda1797e03672f133e06871798d714c2b3 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 16 Dec 2024 19:14:12 +0000 Subject: [PATCH 11/15] indent? --- src/AutoMerge/guidelines.jl | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index abf37552..5158be98 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -350,20 +350,19 @@ function meets_breaking_explanation_check(labels::Vector, body::AbstractString) - ... ``` - """ + """ if release_notes === nothing - return false, "This is a breaking change, but no release notes have been provided." msg = """ - This is a breaking change, but no release notes have been provided. - Please add releas notes that explain the breaking change. - $(example_detail) + This is a breaking change, but no release notes have been provided. + Please add release notes that explain the breaking change. + $(example_detail) """ return false, msg elseif !occursin(r"breaking", lowercase(release_notes)) msg = """ - 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) + 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) """ return false, msg else From 7975ec8f89e6d7b19ba41075ae783ac834691be0 Mon Sep 17 00:00:00 2001 From: Eric Hanson <5846501+ericphanson@users.noreply.github.com> Date: Mon, 16 Dec 2024 22:23:03 +0100 Subject: [PATCH 12/15] refactor and fix indentation --- src/AutoMerge/guidelines.jl | 55 +++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 23 deletions(-) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index 5158be98..1f3e44b2 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -334,36 +334,45 @@ function meets_breaking_explanation_check(data::GitHubAutoMergeData) pr = GitHub.pull_request(data.api, data.registry, data.pr.number; auth=data.auth) return meets_breaking_explanation_check(pr.labels, pr.body) end -function meets_breaking_explanation_check(labels::Vector, body::AbstractString) - if any(==("BREAKING"), labels) - release_notes = get_release_notes(body) - example_detail = """ -
Example of adding release notes with breaking notice - ``` - @JuliaRegistrator register - Release notes: +function breaking_explanation_message(has_release_notes) + example_detail = """ +
Example of adding release notes with breaking notice - ## Breaking changes + ``` + @JuliaRegistrator register - - Explanation of breaking change, ideally with upgrade tips - - ... - ``` -
+ Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ """ + 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. + $(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. + $(example_detail) + """ + end +end + +function meets_breaking_explanation_check(labels::Vector, body::AbstractString) + if any(==("BREAKING"), labels) + release_notes = get_release_notes(body) if release_notes === nothing - msg = """ - This is a breaking change, but no release notes have been provided. - Please add release notes that explain the breaking change. - $(example_detail) - """ + msg = breaking_explanation_message(false) return false, msg elseif !occursin(r"breaking", lowercase(release_notes)) - msg = """ - 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) - """ + msg = breaking_explanation_message(true) return false, msg else return true, "" From 9dfafcd117c80f3af02ac15ef565225fb0a4c47b Mon Sep 17 00:00:00 2001 From: Eric Hanson <5846501+ericphanson@users.noreply.github.com> Date: Mon, 16 Dec 2024 22:24:05 +0100 Subject: [PATCH 13/15] update reference tests --- test/automerge-unit.jl | 2 ++ ...alse_version_0.1.0_point_to_slack_false.md | 34 +++++++++++++++++++ ...false_version_0.1.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...alse_version_1.0.0_point_to_slack_false.md | 34 +++++++++++++++++++ ...false_version_1.0.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...true_version_0.1.0_point_to_slack_false.md | 34 +++++++++++++++++++ ..._true_version_0.1.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...true_version_1.0.0_point_to_slack_false.md | 34 +++++++++++++++++++ ..._true_version_1.0.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...alse_version_0.1.0_point_to_slack_false.md | 34 +++++++++++++++++++ ...false_version_0.1.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...alse_version_1.0.0_point_to_slack_false.md | 34 +++++++++++++++++++ ...false_version_1.0.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...true_version_0.1.0_point_to_slack_false.md | 34 +++++++++++++++++++ ..._true_version_0.1.0_point_to_slack_true.md | 34 +++++++++++++++++++ ...true_version_1.0.0_point_to_slack_false.md | 34 +++++++++++++++++++ ..._true_version_1.0.0_point_to_slack_true.md | 34 +++++++++++++++++++ 17 files changed, 546 insertions(+) diff --git a/test/automerge-unit.jl b/test/automerge-unit.jl index a9b278a3..1eba11de 100644 --- a/test/automerge-unit.jl +++ b/test/automerge-unit.jl @@ -70,6 +70,8 @@ function comment_reference_test() "_version_", version, "_point_to_slack_", point_to_slack) reasons = [ AutoMerge.compat_violation_message(["julia"]), + AutoMerge.breaking_explanation_message(true), + AutoMerge.breaking_explanation_message(false), "Example guideline failed. Please fix it."] fail_text = AutoMerge.comment_text_fail(type, reasons, suggest_onepointzero, version; point_to_slack=point_to_slack) diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md index 895af453..eebfe22e 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md index 10e03a40..8fd94a95 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md index 895af453..eebfe22e 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md index 10e03a40..8fd94a95 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md index 88720bb6..26c9287c 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md index 7330fb86..ab35f752 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md index 895af453..eebfe22e 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md index 10e03a40..8fd94a95 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md @@ -29,6 +29,40 @@ Please make sure that you have read the [package naming guidelines](https://juli +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 3. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md index ff610b84..7f4c48d9 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md index 93bf7bf3..dd3ee0ab 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md index ff610b84..7f4c48d9 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md index 93bf7bf3..dd3ee0ab 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md index a2e16fbd..a4fec245 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md index 259f3481..b3b05176 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md index ff610b84..7f4c48d9 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md index 93bf7bf3..dd3ee0ab 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md @@ -25,6 +25,40 @@ Hello, I am an automated registration bot. I help manage the registration proces +- This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change. +
Example of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + +- 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 of adding release notes with breaking notice + + ``` + @JuliaRegistrator register + + Release notes: + + ## Breaking changes + + - Explanation of breaking change, ideally with upgrade tips + - ... + ``` + +
+ + - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next From 34367b742375cb4670bb310b895b0cf33c22fc52 Mon Sep 17 00:00:00 2001 From: Eric Hanson <5846501+ericphanson@users.noreply.github.com> Date: Mon, 16 Dec 2024 22:27:30 +0100 Subject: [PATCH 14/15] add more details and include JuliaHub --- src/AutoMerge/guidelines.jl | 3 +++ ...onepointzero_false_version_0.1.0_point_to_slack_false.md | 6 ++++++ ..._onepointzero_false_version_0.1.0_point_to_slack_true.md | 6 ++++++ ...onepointzero_false_version_1.0.0_point_to_slack_false.md | 6 ++++++ ..._onepointzero_false_version_1.0.0_point_to_slack_true.md | 6 ++++++ ..._onepointzero_true_version_0.1.0_point_to_slack_false.md | 6 ++++++ ...t_onepointzero_true_version_0.1.0_point_to_slack_true.md | 6 ++++++ ..._onepointzero_true_version_1.0.0_point_to_slack_false.md | 6 ++++++ ...t_onepointzero_true_version_1.0.0_point_to_slack_true.md | 6 ++++++ ...onepointzero_false_version_0.1.0_point_to_slack_false.md | 6 ++++++ ..._onepointzero_false_version_0.1.0_point_to_slack_true.md | 6 ++++++ ...onepointzero_false_version_1.0.0_point_to_slack_false.md | 6 ++++++ ..._onepointzero_false_version_1.0.0_point_to_slack_true.md | 6 ++++++ ..._onepointzero_true_version_0.1.0_point_to_slack_false.md | 6 ++++++ ...t_onepointzero_true_version_0.1.0_point_to_slack_true.md | 6 ++++++ ..._onepointzero_true_version_1.0.0_point_to_slack_false.md | 6 ++++++ ...t_onepointzero_true_version_1.0.0_point_to_slack_true.md | 6 ++++++ 17 files changed, 99 insertions(+) diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index 1f3e44b2..0044a6c8 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -339,6 +339,8 @@ function breaking_explanation_message(has_release_notes) example_detail = """
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -350,6 +352,7 @@ 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.
""" if has_release_notes diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md index eebfe22e..475164e9 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md index 8fd94a95..913ffe52 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md index eebfe22e..475164e9 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md index 8fd94a95..913ffe52 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md index 26c9287c..189a927e 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md index ab35f752..a22323d9 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md index eebfe22e..475164e9 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md index 8fd94a95..913ffe52 100644 --- a/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_package_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md @@ -32,6 +32,8 @@ Please make sure that you have read the [package naming guidelines](https://juli - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -43,12 +45,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -60,6 +65,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md index 7f4c48d9..439c09b5 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_false.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md index dd3ee0ab..2551ec36 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_0.1.0_point_to_slack_true.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md index 7f4c48d9..439c09b5 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_false.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md index dd3ee0ab..2551ec36 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_false_version_1.0.0_point_to_slack_true.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md index a4fec245..d86abb09 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_false.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md index b3b05176..2384a9f7 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_0.1.0_point_to_slack_true.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md index 7f4c48d9..439c09b5 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_false.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
diff --git a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md index dd3ee0ab..2551ec36 100644 --- a/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md +++ b/test/reference_comments/comment_pass_false_type_new_version_suggest_onepointzero_true_version_1.0.0_point_to_slack_true.md @@ -28,6 +28,8 @@ Hello, I am an automated registration bot. I help manage the registration proces - This is a breaking change, but no release notes have been provided. Please add release notes that explain the breaking change.
Example of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -39,12 +41,15 @@ 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.
- 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 of adding release notes with breaking notice + If you are using the comment bot `@JuliaRegistrator`, you can add release notes to this registration by re-triggering registration while specifying release notes: + ``` @JuliaRegistrator register @@ -56,6 +61,7 @@ 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.
From fe80c9e0e774af8684707fc3b5bee79dca9e3d62 Mon Sep 17 00:00:00 2001 From: Eric Hanson <5846501+ericphanson@users.noreply.github.com> Date: Mon, 16 Dec 2024 22:40:34 +0100 Subject: [PATCH 15/15] Update Project.toml --- Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Project.toml b/Project.toml index e9929221..0aabcb85 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "RegistryCI" uuid = "0c95cc5f-2f7e-43fe-82dd-79dbcba86b32" authors = ["Dilum Aluthge ", "Fredrik Ekre ", "contributors"] -version = "10.9.1" +version = "10.10.0" [deps] Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"