Require `[compat]` for stdlib dependencies #516

vchuravy · 2023-10-06T15:27:16Z

Fixes #515, by no longer treating stdlibs as special.

(Note: previously, this PR also added the requirement for JLL dependencies. That was removed from this PR.)

vchuravy · 2023-10-06T15:28:32Z

This may be to aggressive, but I do think that we need compat entries at least for every stdlib.

DilumAluthge

SGTM.

~~Note that the JLL requirement will only apply to non-JLL packages. In other words:~~

Suppose that Foo.jl depends on Bar.jl and Hello_jll.jl. Foo.jl must have a compat entry for Bar.jl (this was already the case before this PR). Foo.jl must have a compat entry for Hello_jll.jl (this is new, introduced in this PR).
Suppose that Hello_jll.jl depends on World_jll.jl. Hello_jll.jl does NOT need a compat entry for World_jll.jl. This is one of the "special JLL exceptions" that we apply to JLL packages that come from Yggdrasil.

DilumAluthge · 2023-10-06T15:41:36Z

cc: @staticfloat @giordano (to take a quick look at the JLL-related changes)

ericphanson · 2023-10-06T17:28:29Z

This change makes sense to me, but when deployed, this should be accompanied by a discourse post announcing the change and the rationale. (Including what authors should do, e.g. how should they set compat bounds on stdlibs)

vchuravy · 2023-10-06T19:35:23Z

@ericphanson how about the following annoucement

PSA: Compat requirements in the General registry are changing.

Up until now standard libraries (and JLL's) have been excluded from the mandatory
requirement of being listed in [compat]. Since the version of a standard library was
tightly coupled to the version of Julia it was shipped with.

In Julia v1.11 (and to an lesser extend v1.10) we are moving towards upgradeable standard libaries,
this means that Julia will still come with the same selection of standard libraries, but instead of waiting
for a new Julia release, standard libraries will have their own release cycle. So it should be possible in
the future to use Pkg v1.12 on Julia v1.11.

In effect standard libraries are becoming normal Julia packages, with the only difference that a version of
them will be shipped with a default Julia install.

Now this means that version numbers of standard libraries and Julia are no longer coupled and one
must manually declare [compat] requirements for standard libraries as well as Julia in your Project.toml.
We will handle the registry side of things automatically, but developers will have to
manually adjust their Project.toml the next time they release a version to the registry.

So a Project.toml like:

name = "TestStdlibMissingCompat"
uuid = "4a0d4eb6-ee8c-4d0f-9d49-1daa6f6c32cf"
authors = ["Valentin Churavy <v.churavy@gmail.com>"]
version = "0.1.0"

[deps]
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

[compat]
julia = "1.9"

Would become:

name = "TestStdlibMissingCompat"
uuid = "4a0d4eb6-ee8c-4d0f-9d49-1daa6f6c32cf"
authors = ["Valentin Churavy <v.churavy@gmail.com>"]
version = "0.1.0"

[deps]
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

[compat]
julia = "1.9"
Statistics = "1.9"

DilumAluthge · 2023-10-06T19:51:09Z

In your example Project.toml file, can you also add an example JLL dependency, just for purposes of illustration?

giordano

If this doesn't enforce compat bounds in jlls, as said above, then it looks good to me. For enforcing compat bounds also in jlls, which I'd like to, I'd need help with JuliaPackaging/BinaryBuilderBase.jl#314, I had troubles with installation of stdlib jlls in the build environment

ericphanson · 2023-10-06T20:19:56Z

That sounds great to me, but I agree with Dilum we should mention more JLLs too, not just stdlibs, since we're changing both here. (We mentioned they were exempt but not that they are no longer exempt). Also as a tiny grammar nit,

Since the version of a standard library was tightly coupled to the version of Julia it was shipped with.

is kinda an incomplete sentence; maybe:

Stdlibs were exempt because the version of a standard library was tightly coupled to the version of Julia it was shipped with.

DilumAluthge · 2023-10-06T20:26:44Z

@vchuravy and/or @staticfloat - can you help @giordano out with JuliaPackaging/BinaryBuilderBase.jl#314?

src/AutoMerge/guidelines.jl

vchuravy · 2023-10-14T19:05:21Z

After a conversation with @DilumAluthge I would say let's back out the JLL change for now, that seems like a bigger change and the stdlib change needs to happen now.
We are already likely to have some inconsistencies in the Registry.

Stale

DilumAluthge · 2023-10-14T19:55:11Z

https://discourse.julialang.org/t/psa-compat-requirements-in-the-general-registry-are-changing/104958?u=dilumaluthge

DilumAluthge · 2023-10-14T21:25:29Z

Let's call this breaking. I've bumped the major version number to 9.

refs: + https://discourse.julialang.org/t/psa-compat-requirements-in-the-general-registry-are-changing/104958 + JuliaRegistries/RegistryCI.jl#516

DilumAluthge · 2023-10-19T17:01:14Z

bors try

bors · 2023-10-19T17:19:50Z

try

Build failed:

Integration/Julia 1/ubuntu-latest/x64

DilumAluthge · 2023-10-19T17:32:50Z

@vchuravy We need to fix several of the integration tests.

DilumAluthge · 2023-10-19T23:13:43Z

bors try

bors · 2023-10-19T23:28:21Z

try

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

DilumAluthge

LGTM

DilumAluthge · 2023-10-26T05:18:12Z

bors merge

bors · 2023-10-26T05:36:09Z

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

DilumAluthge · 2023-10-26T05:49:15Z

This will be registered in JuliaRegistries/General#94135.

DilumAluthge · 2023-10-26T06:53:00Z

This will be deployed by the combination of JuliaRegistries/General#94141 and JuliaRegistries/General#94142

vchuravy · 2023-10-26T14:05:09Z

I reran StdlibRegistryCompatUpdater for DelimitedFiles and Statistics JuliaRegistries/General#94159

Require [compat] for all dependencies

5c944ec

vchuravy requested review from 00vareladavid, DilumAluthge, KristofferC, staticfloat and giordano and removed request for 00vareladavid October 6, 2023 15:27

DilumAluthge previously approved these changes Oct 6, 2023

View reviewed changes

giordano reviewed Oct 6, 2023

View reviewed changes

vchuravy mentioned this pull request Oct 7, 2023

Upgradable stdlibs JuliaLang/julia#50697

Open

back out JLL change for now

dba1c5c

DilumAluthge reviewed Oct 14, 2023

View reviewed changes

src/AutoMerge/guidelines.jl Outdated Show resolved Hide resolved

fixup

9a2ed55

vchuravy changed the title ~~Require [compat] for all dependencies~~ Require [compat] for stdlib dependencies Oct 14, 2023

vchuravy mentioned this pull request Oct 14, 2023

Require compat statements for JLLs. #517

Open

DilumAluthge self-requested a review October 14, 2023 19:53

DilumAluthge self-assigned this Oct 14, 2023

DilumAluthge changed the title ~~Require [compat] for stdlib dependencies~~ Require [compat] for stdlib dependencies Oct 14, 2023

DilumAluthge mentioned this pull request Oct 14, 2023

We need to start opening PRs to add/update compat entries for stdlibs JuliaRegistries/CompatHelper.jl#456

Closed

Bump the major version number to 9

bdf76fb

DilumAluthge added the breaking change label Oct 14, 2023

DilumAluthge mentioned this pull request Oct 16, 2023

Registry consistency tests: before doing certain equality comparisons, add whitespace before and after hyphens #514

Merged

dahong67 added a commit to dahong67/GCPDecompositions.jl that referenced this pull request Oct 17, 2023

Add compat for stdlibs

24e2cfe

refs: + https://discourse.julialang.org/t/psa-compat-requirements-in-the-general-registry-are-changing/104958 + JuliaRegistries/RegistryCI.jl#516

bors bot added a commit that referenced this pull request Oct 19, 2023

Try #516:

0888158

update integration tests

176ffd4

bors bot added a commit that referenced this pull request Oct 19, 2023

Try #516:

9057cea

DilumAluthge approved these changes Oct 26, 2023

View reviewed changes

Merge branch 'master' into vc/require_compat_for_all

0974fd6

bors bot merged commit 3082b39 into master Oct 26, 2023
11 checks passed

bors bot deleted the vc/require_compat_for_all branch October 26, 2023 05:36

DilumAluthge mentioned this pull request Oct 26, 2023

New version: RegistryCI v9.0.0 JuliaRegistries/General#94135

Merged

miguelbiron mentioned this pull request Oct 30, 2023

CompatHelper: add new compat entry for Statistics at version 1, (keep existing compat) Julia-Tempering/Pigeons.jl#166

Merged

DilumAluthge mentioned this pull request Jan 29, 2024

AutoMerge: temporarily disable the "Require [compat] for stdlib dependencies" feature" #540

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Require `[compat]` for stdlib dependencies #516

Require `[compat]` for stdlib dependencies #516

vchuravy commented Oct 6, 2023 •

edited by DilumAluthge

Loading

vchuravy commented Oct 6, 2023

DilumAluthge left a comment •

edited

Loading

DilumAluthge commented Oct 6, 2023

ericphanson commented Oct 6, 2023 •

edited

Loading

vchuravy commented Oct 6, 2023 •

edited

Loading

DilumAluthge commented Oct 6, 2023

giordano left a comment

ericphanson commented Oct 6, 2023

DilumAluthge commented Oct 6, 2023

vchuravy commented Oct 14, 2023

DilumAluthge commented Oct 14, 2023

DilumAluthge commented Oct 14, 2023

DilumAluthge commented Oct 19, 2023

bors bot commented Oct 19, 2023

DilumAluthge commented Oct 19, 2023

DilumAluthge commented Oct 19, 2023

bors bot commented Oct 19, 2023

DilumAluthge left a comment

DilumAluthge commented Oct 26, 2023

bors bot commented Oct 26, 2023

DilumAluthge commented Oct 26, 2023

DilumAluthge commented Oct 26, 2023

vchuravy commented Oct 26, 2023

Require [compat] for stdlib dependencies #516

Require [compat] for stdlib dependencies #516

Conversation

vchuravy commented Oct 6, 2023 • edited by DilumAluthge Loading

vchuravy commented Oct 6, 2023

DilumAluthge left a comment • edited Loading

Choose a reason for hiding this comment

DilumAluthge commented Oct 6, 2023

ericphanson commented Oct 6, 2023 • edited Loading

vchuravy commented Oct 6, 2023 • edited Loading

PSA: Compat requirements in the General registry are changing.

DilumAluthge commented Oct 6, 2023

giordano left a comment

Choose a reason for hiding this comment

ericphanson commented Oct 6, 2023

DilumAluthge commented Oct 6, 2023

vchuravy commented Oct 14, 2023

DilumAluthge commented Oct 14, 2023

DilumAluthge commented Oct 14, 2023

DilumAluthge commented Oct 19, 2023

bors bot commented Oct 19, 2023

try

DilumAluthge commented Oct 19, 2023

DilumAluthge commented Oct 19, 2023

bors bot commented Oct 19, 2023

try

DilumAluthge left a comment

Choose a reason for hiding this comment

DilumAluthge commented Oct 26, 2023

bors bot commented Oct 26, 2023

DilumAluthge commented Oct 26, 2023

DilumAluthge commented Oct 26, 2023

vchuravy commented Oct 26, 2023

Require `[compat]` for stdlib dependencies #516

Require `[compat]` for stdlib dependencies #516

vchuravy commented Oct 6, 2023 •

edited by DilumAluthge

Loading

DilumAluthge left a comment •

edited

Loading

ericphanson commented Oct 6, 2023 •

edited

Loading

vchuravy commented Oct 6, 2023 •

edited

Loading