Skip to content

[BREAKING] Remove the verbose field, and use the Julia logging system instead #23

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

Merged
merged 2 commits into from
Feb 7, 2025
Merged

[BREAKING] Remove the verbose field, and use the Julia logging system instead #23

merged 2 commits into from
Feb 7, 2025

Conversation

DilumAluthge
Copy link
Member

@DilumAluthge DilumAluthge commented Dec 30, 2024

Important note: This is a breaking change, and thus will require a breaking release of SlurmClusterManager.jl.

The idea here is to get rid of the .verbose field, and instead log the message using @debug. Then, if the user wants to turn on verbose logging, they just e.g. set the JULIA_DEBUG=SlurmClusterManager environment variable.

This allows the logging in this package to be composable with the rest of the Logging ecosystem in Julia.

@DilumAluthge
Copy link
Member Author

@kleinhenz What are your thoughts on this PR?

(I don't think we should merge this yet. It's a breaking change, so we can hold off on merging for now. But I figured it'd be good to get some feedback from you now.)

@DilumAluthge
Copy link
Member Author

Bump @kleinhenz - any thoughts on this PR?

@kleinhenz
Copy link
Collaborator

this makes sense to me. is @debug hidden by default?

@DilumAluthge
Copy link
Member Author

this makes sense to me. is @debug hidden by default?

Yep, exactly. By default, @debug messages won't be shown. The user can enable them by doing e.g. export JULIA_DEBUG="SlurmClusterManager" or ENV["JULIA_DEBUG"] = "SlurmClusterManager".

@DilumAluthge DilumAluthge marked this pull request as ready for review January 27, 2025 01:56
@DilumAluthge DilumAluthge marked this pull request as draft January 27, 2025 01:56
@DilumAluthge
Copy link
Member Author

@kleinhenz Are there any other breaking changes that you anticipate making in the near future?

If there aren't any other breaking changes coming up in the pipeline, I'd suggest that we merge this PR and register v1.0.0.

@DilumAluthge
Copy link
Member Author

@kleinhenz Bumping on this. Do you have any plans for any more breaking changes in the near future?

@kleinhenz
Copy link
Collaborator

No plans for more breaking changes. If this is ready I can merge and make a release

@DilumAluthge
Copy link
Member Author

Can you make one last 0.x release that includes #40?

After that, we can merge this PR, and then release 1.0.0.

@kleinhenz
Copy link
Collaborator

ok a new release is in progress now

@DilumAluthge
Copy link
Member Author

Thanks so much! I see that v0.1.5 has now been tagged.

I'll mark this PR as ready.

@DilumAluthge DilumAluthge marked this pull request as ready for review January 30, 2025 15:11
@DilumAluthge
Copy link
Member Author

Bump @kleinhenz. Now that v0.1.5 has been registered, shall we move forward with:

  1. Merging this PR.
  2. Registering v1.0.0.

@kleinhenz kleinhenz merged commit 8d568ea into JuliaParallel:master Feb 7, 2025
4 checks passed
@DilumAluthge DilumAluthge deleted the dpa/verbose-BREAKINGCHANGE branch February 7, 2025 12:49
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