Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the tests to new API #7

Merged
merged 1 commit into from
Sep 22, 2024
Merged

Conversation

timholy
Copy link
Collaborator

@timholy timholy commented Apr 16, 2024

This copies the old tests to tests/deprecations.jl and updates runtests.jl to use the new API. The main tests pass even with julia --depwarn=error (though it will error when it includes the test/deprecations.jl file).

@timholy
Copy link
Collaborator Author

timholy commented Apr 16, 2024

Once this gets merged to master, then I'd recommend the following steps:

  • you can release version 0.1.1 simply by commenting @JuliaRegistrator register on the most recent commit on the master branch, https://github.com/rdoelman/ZernikePolynomials.jl/commits/master/ (it should be the commit that merges this PR)
  • once 0.1.1 is available, your users have a smooth path to upgrading to the new API, with helpful warnings telling them how to update their code. From that point, whenever you wish you can adopt a "clean" version of the package by making the new API required:
    • delete src/deprecations.jl and test/deprecations.jl
    • remove the corresponding include("deprecations.jl") directives in src/ZernickePolynomials.jl and test/runtests.jl
    • bump the version in Project.toml to 0.2.0
    • release

Bumping the version to 0.2.0 signals a breaking change, which is important because by removing the deprecations you make the old API not work anymore.

@timholy
Copy link
Collaborator Author

timholy commented May 21, 2024

Bump. It would be nice to get a release with these changes. If you're unsure of how to do such things, I personally would recommend transferring this package to JuliaMath (see #4) so that others can take on the maintenance burden for this package.

@timholy
Copy link
Collaborator Author

timholy commented Jul 3, 2024

Bump

@rdoelman rdoelman merged commit a67629c into rdoelman:master Sep 22, 2024
3 checks passed
@timholy timholy deleted the teh/update_tests branch September 23, 2024 11:29
@timholy
Copy link
Collaborator Author

timholy commented Sep 23, 2024

@rdoelman, would you like help with the items in #7 (comment)? If you invite me to collaborate on this repo I can take those steps.

@rdoelman
Copy link
Owner

That would be very much appreciated! I've added you.

@timholy
Copy link
Collaborator Author

timholy commented Sep 23, 2024

Thanks! Looks like there may be one step you'll have to take: can you click the "Install app" button on https://github.com/JuliaRegistries/Registrator.jl?tab=readme-ov-file#via-the-web-interface. You'll likely have to choose whether you want to install it on all your repositories or just a select subset. I've chosen it for all of mine:
image

When that's done, I think I'll have permissions for the rest, so let me know when it's ready.

@timholy
Copy link
Collaborator Author

timholy commented Sep 24, 2024

@rdoelman, there's nothing I can do until you add the Registrator app (<60s of work). If you do that I can handle the rest.

Alternatively, #4 remains an option if you'd prefer. At JuliaMath I could do the whole thing. It's just a permission issue.

@rdoelman
Copy link
Owner

I've taken care of it.

@timholy
Copy link
Collaborator Author

timholy commented Sep 25, 2024

It works! JuliaRegistries/General#115980

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants