Skip to content

Add options for handling [extras] dependencies#528

Merged
DilumAluthge merged 11 commits intoJuliaRegistries:masterfrom
devmotion:dw/extras
Dec 12, 2025
Merged

Add options for handling [extras] dependencies#528
DilumAluthge merged 11 commits intoJuliaRegistries:masterfrom
devmotion:dw/extras

Conversation

@devmotion
Copy link
Copy Markdown
Contributor

@devmotion devmotion commented Aug 13, 2025

This PR extends #502 based on @DilumAluthge's suggestions in #502 (comment).

I added an option open_prs_for_extras that can be set to IfExistingCompatExtras() (the default), AllExtras() or NoExtras() [my gut feeling is that the names could be improved a bit]. With IfExistingCompatExtras(), only [extras] dependencies with existing compat entry are updated; with AllExtras(), all [extras] dependencies are updated (also those without existing compat entry); and with NoExtras(), [extras] dependencies are not updated.

I went with singleton types (basically a type-based enum) because 1) it felt more consistent with the existing EntryType and 2) it's not necessary to check whether the provided value is valid (which would be necessary if the API would be based on Symbols).

Fixes #166. Closes #502.

@codecov
Copy link
Copy Markdown

codecov bot commented Aug 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7ea4330) to head (cd36c36).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #528   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        11    -1     
  Lines          412       411    -1     
=========================================
- Hits           412       411    -1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@DilumAluthge
Copy link
Copy Markdown
Member

Could we make this experimental for now? That way, we can try it out, and if we don't like the API, we can change it?

@DilumAluthge
Copy link
Copy Markdown
Member

By "experimental", I mean explicitly document that we are allowed to break it in a minor (or even patch) release of CompatHelper.

Comment thread src/main.jl Outdated
@devmotion
Copy link
Copy Markdown
Contributor Author

I added a note.

@DilumAluthge DilumAluthge self-requested a review September 4, 2025 23:42
Comment thread src/main.jl Outdated
Co-authored-by: Dilum Aluthge <dilum@aluthge.com>
@DilumAluthge DilumAluthge self-requested a review September 4, 2025 23:47
Comment thread src/CompatHelper.jl Outdated
Comment thread src/main.jl Outdated
Comment thread test/deps/Project.toml Outdated
devmotion and others added 2 commits September 5, 2025 02:23
Comment thread src/main.jl Outdated
Comment thread src/main.jl Outdated
@devmotion
Copy link
Copy Markdown
Contributor Author

@DilumAluthge this PR is ready for another round of review 🙂

@devmotion
Copy link
Copy Markdown
Contributor Author

@DilumAluthge bump 🙂

@DilumAluthge
Copy link
Copy Markdown
Member

I can try to review this weekend.

@DilumAluthge
Copy link
Copy Markdown
Member

I can try to review this weekend.

Famous last words, huh?

Copy link
Copy Markdown
Member

@DilumAluthge DilumAluthge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good to me.

There's one tweak I'd like to make to the tests (just to restore Baz back to [deps], as it was before this PR). Once that's done, I think this PR is good to merge.

Comment thread test/deps/Project.toml Outdated
@DilumAluthge DilumAluthge added this pull request to the merge queue Dec 12, 2025
Merged via the queue into JuliaRegistries:master with commit e865537 Dec 12, 2025
10 checks passed
@devmotion
Copy link
Copy Markdown
Contributor Author

@DilumAluthge can you create a new release?

@DilumAluthge
Copy link
Copy Markdown
Member

#536

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.

check "extras" not just "deps" ?

3 participants