Use ITensorActions CompatHelper

[mtfishman]

The basic goal here is to enable the CompatHelper workflow to search the ITensorRegistry along with the General registry for updated packages.

I'm following the instructions here: https://juliaregistries.github.io/CompatHelper.jl/dev/options/#Custom-registries and here: https://github.com/julia-actions/add-julia-registry?tab=readme-ov-file.

Unfortunately I don't really know how to test if this is working. I plan to add these updates to NamedDimsArrays.jl and see if it picks up on this breaking release of TypeParameterAccessors.jl: ITensor/TypeParameterAccessors.jl#26 once it is registered.

@lkdvos does this look right to you? I wasn't sure if that is the right ssh-key to use but that is the one that is used in other workflows.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.28%. Comparing base (974d356) to head (0d5e60e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #47   +/-   ##
=======================================
  Coverage   72.28%   72.28%           
=======================================
  Files           1        1           
  Lines          83       83           
=======================================
  Hits           60       60           
  Misses         23       23           

Flag	Coverage Δ
docs	72.28% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lkdvos]

I think I would expect that you would have to first run the "add registry" step here, and follow that up with the compathelper run.
As an organizational note, it would probably be easier if we use the template to simply call out to ITensorActions for a compathelper workflow, and add the logic there. That way, we won't have to modify the repositories if we need to update this

[mtfishman]

I think I would expect that you would have to first run the "add registry" step here, and follow that up with the compathelper run.

I don't really know what you mean/how to do that. But anyway, I'll try running it like this instead and not using the add-julia-registry workflow:

using CompatHelper
using Pkg
registries = [
    Pkg.RegistrySpec(
        name = "General",
        uuid = "23338594-aafe-5451-b93e-139f81909106",
        url = "https://github.com/JuliaRegistries/General.git",
    ),
    Pkg.RegistrySpec(
        name = "ITensorRegistry",
        uuid = "c4d53e37-7e0e-4be9-ba6f-c27e01f48020",
        url = "https://github.com/ITensor/ITensorRegistry.git",
    ),
]
CompatHelper.main(; registries)

which seems a bit simpler for now.

As an organizational note, it would probably be easier if we use the template to simply call out to ITensorActions for a compathelper workflow, and add the logic there. That way, we won't have to modify the repositories if we need to update this

That's a good point, I had kind of forgotten about that but I'll try to set it up that way instead.

[lkdvos]

Sorry, what I meant was that now, the CompatHelper workflow doesn't actually know about the ITensor registry being installed, since it isn't necessarily installed. You would have to first install that registry, within the compathelper workflow, and then run the commands you have here.
Honestly, I'm already quite confused that the workflow we previously had worked at all, since it doesn't even install julia. The latest workflow in CompatHelper.jl already has a bit more of what I would expect, and I'm guessing you can hardcode that one to add the ITensor registry.
Alternatively, to make that configurable, I would look at the example here

[mtfishman]

Gotcha, thanks, I'll try to put something together in a workflow in ITensorActions.

[mtfishman]

Alright, I've updated to now use the workflow introduced in ITensor/ITensorActions#4.

[mtfishman]

Updated reflecting the new shared CompatHelper workflow in ITensorActions (https://github.com/ITensor/ITensorActions?tab=readme-ov-file#compathelper), which allows customizing which local registries to search in, but now requires explicitly specifying the ITensorRegistry. Tested out in https://github.com/ITensor/NamedDimsArrays.jl and it appears to work.

[mtfishman]

@lkdvos I think I've gotten this down to being as simple as it can be, let me know if you're good with this being merged.

[lkdvos]

Looks very compact and clean, and easily maintainable!