From ddce19a7f88850b036e0eb8375a968db11d97fb0 Mon Sep 17 00:00:00 2001 From: Eric Hanson <5846501+ericphanson@users.noreply.github.com> Date: Wed, 26 Jun 2024 01:05:59 +0200 Subject: [PATCH] try adding an "extended explanation" to compat bounds (#566) * try adding an "extended explanation" * mention `julia` compat * comment out `...` * Update Project.toml --- Project.toml | 2 +- src/AutoMerge/guidelines.jl | 42 ++++++++++++++++--- test/automerge-unit.jl | 4 +- ...alse_version_0.1.0_point_to_slack_false.md | 23 ++++++++++ ...false_version_0.1.0_point_to_slack_true.md | 23 ++++++++++ ...alse_version_1.0.0_point_to_slack_false.md | 23 ++++++++++ ...false_version_1.0.0_point_to_slack_true.md | 23 ++++++++++ ...true_version_0.1.0_point_to_slack_false.md | 23 ++++++++++ ..._true_version_0.1.0_point_to_slack_true.md | 23 ++++++++++ ...true_version_1.0.0_point_to_slack_false.md | 23 ++++++++++ ..._true_version_1.0.0_point_to_slack_true.md | 23 ++++++++++ ...alse_version_0.1.0_point_to_slack_false.md | 23 ++++++++++ ...false_version_0.1.0_point_to_slack_true.md | 23 ++++++++++ ...alse_version_1.0.0_point_to_slack_false.md | 23 ++++++++++ ...false_version_1.0.0_point_to_slack_true.md | 23 ++++++++++ ...true_version_0.1.0_point_to_slack_false.md | 23 ++++++++++ ..._true_version_0.1.0_point_to_slack_true.md | 23 ++++++++++ ...true_version_1.0.0_point_to_slack_false.md | 23 ++++++++++ ..._true_version_1.0.0_point_to_slack_true.md | 23 ++++++++++ 19 files changed, 408 insertions(+), 8 deletions(-) diff --git a/Project.toml b/Project.toml index fe8e9264..aabaf7c0 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.4.0" +version = "10.5.0" [deps] Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" diff --git a/src/AutoMerge/guidelines.jl b/src/AutoMerge/guidelines.jl index 3c76b1e8..06d408a0 100644 --- a/src/AutoMerge/guidelines.jl +++ b/src/AutoMerge/guidelines.jl @@ -84,6 +84,41 @@ const guideline_compat_for_all_deps = Guideline(; check=data -> meets_compat_for_all_deps(data.registry_head, data.pkg, data.version), ) +function compat_violation_message(bad_dependencies) + return string( + "The following dependencies do not have a `[compat]` entry ", + "that is upper-bounded and only includes a finite number ", + "of breaking releases: ", + join(bad_dependencies, ", "), + # Note the indentation here is important for the proper formatting within a bulleted list later + """ + +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ """ + ) + +end + function meets_compat_for_all_deps(working_directory::AbstractString, pkg, version) package_relpath = get_package_relpath_in_registry(; package_name=pkg, registry_path=working_directory @@ -155,12 +190,7 @@ function meets_compat_for_all_deps(working_directory::AbstractString, pkg, versi end end sort!(bad_dependencies) - message = string( - "The following dependencies do not have a `[compat]` entry ", - "that is upper-bounded and only includes a finite number ", - "of breaking releases: ", - join(bad_dependencies, ", "), - ) + message = compat_violation_message(bad_dependencies) return false, message end end diff --git a/test/automerge-unit.jl b/test/automerge-unit.jl index 007f5530..230bdced 100644 --- a/test/automerge-unit.jl +++ b/test/automerge-unit.jl @@ -68,7 +68,9 @@ function comment_reference_test() name = string("comment", "_pass_", pass, "_type_", type_name, "_suggest_onepointzero_", suggest_onepointzero, "_version_", version, "_point_to_slack_", point_to_slack) - reasons = ["Example guideline failed. Please fix it."] + reasons = [ + AutoMerge.compat_violation_message(["julia"]), + "Example guideline failed. Please fix it."] fail_text = AutoMerge.comment_text_fail(type, reasons, suggest_onepointzero, version; point_to_slack=point_to_slack) @test_reference "reference_comments/$name.md" fail_text by=strip_equal 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 ea80555d..ba10e3f9 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 39324b6a..03fb3d58 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 ea80555d..ba10e3f9 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 39324b6a..03fb3d58 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 c85dd650..f345d6bc 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 572774af..78b23303 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 ea80555d..ba10e3f9 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 39324b6a..03fb3d58 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 @@ -6,6 +6,29 @@ Please make sure that you have read the [package naming guidelines](https://juli ## 2. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 9c2af400..e84fd6ff 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 87834ec9..64da4ee6 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 9c2af400..e84fd6ff 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 87834ec9..64da4ee6 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 a67ff132..b1381e0a 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 e523e56b..fa0dfc8b 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 9c2af400..e84fd6ff 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - 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 87834ec9..64da4ee6 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 @@ -2,6 +2,29 @@ Hello, I am an automated registration bot. I help manage the registration proces ## 1. [AutoMerge Guidelines](https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/) which are not met ❌ +- The following dependencies do not have a `[compat]` entry that is upper-bounded and only includes a finite number of breaking releases: julia +
Extended explanation + + Your package has a Project.toml file which might look something like the following: + + ```toml + name = "YourPackage" + uuid = "random id" + authors = ["Author Names"] + version = "major.minor" + + [deps] + # Package dependencies + # ... + + [compat] + # ... + ``` + + Every package listed in `[deps]`, along with `julia` itself, must also be listed under `[compat]` (if you don't have a `[compat]` section, make one!). See the [Pkg docs](https://pkgdocs.julialang.org/v1/compatibility/) for the syntax for compatibility bounds. + +
+ - Example guideline failed. Please fix it. ## 2. *Needs action*: here's what to do next