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

add compat bounds for stdlibs #1711

Merged
merged 3 commits into from
Nov 7, 2023
Merged

add compat bounds for stdlibs #1711

merged 3 commits into from
Nov 7, 2023

Conversation

ranocha
Copy link
Member

@ranocha ranocha commented Nov 7, 2023

I added compat bounds for stdlibs since we cannot register new versions of Trixi.jl without them. I followed the recommendation in https://discourse.julialang.org/t/psa-compat-requirements-in-the-general-registry-are-changing/104958 since we didn't get any response in JuliaRegistries/TagBot#292.

The only exception to the rule above is Downloads - which is available in Julia v1.8 only as v1.6 and not v1.8 as usual...

Closes #1693, closes #1694

Copy link
Contributor

github-actions bot commented Nov 7, 2023

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@ranocha ranocha requested a review from sloede November 7, 2023 06:45
@ranocha ranocha changed the title add comapt bounds for stdlibs add compat bounds for stdlibs Nov 7, 2023
@sloede
Copy link
Member

sloede commented Nov 7, 2023

Note that they recently updated the PSA and are now (IMHO) somewhat confusingly also recommend to set the compat bound to 1 for packages supporting Julia 1.4 or higher. Since CompatHelper still wants to set bounds to 1, maybe we should do so as well for the time being at least?

@ranocha
Copy link
Member Author

ranocha commented Nov 7, 2023

Done

Copy link

codecov bot commented Nov 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3186df5) 83.00% compared to head (ed2bfc9) 72.60%.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1711       +/-   ##
===========================================
- Coverage   83.00%   72.60%   -10.40%     
===========================================
  Files         431      431               
  Lines       34665    34637       -28     
===========================================
- Hits        28772    25145     -3627     
- Misses       5893     9492     +3599     
Flag Coverage Δ
unittests 72.60% <ø> (-10.40%) ⬇️

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

see 116 files with indirect coverage changes

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

Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Thanks!

@sloede sloede merged commit 276dc3c into main Nov 7, 2023
27 of 32 checks passed
@sloede sloede deleted the hr/compat_stdlibs branch November 7, 2023 09:33
@JoshuaLampert JoshuaLampert mentioned this pull request Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Default [compat] setting for standard libraries
2 participants