Fixes typo in Caching envvar #424
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Envvar to set caching mode was previously CLOUPATHLIB_FILE_CACHE_MODE (missing D in CLOUDPATHLIB). This commit fixes this typo and introduces some code to help migrate projects to the new envvar. The current logic for migration warnings is: - If the old envvar is set and not the new one, use the old one and issue a deprecation warning - If the old and new envvars are set, use the new version and issue a warning if the two disagree
mynameisfiber
force-pushed
the
bugfix/envvar-typo
branch
from
679ffc2 to
ca3b77d
Compare
pjbull
requested changes
Apr 8, 2024
There was a problem hiding this comment.
Great, thanks! I think this should be good when the tests are passing. You should be able to run locally to diagnose with the make test command:
https://cloudpathlib.drivendata.org/stable/contributing/#tests
Could you also file an issue to remove the deprecated code in a future release?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #424 +/- ##
========================================
- Coverage 93.8% 93.4% -0.4%
========================================
Files 23 23
Lines 1639 1646 +7
========================================
+ Hits 1538 1539 +1
- Misses 101 107 +6
|
pjbull
approved these changes
Apr 9, 2024
|
Moving to repo-local branch where the live backend tests can run. Thanks @mynameisfiber! |
pjbull
added a commit
that referenced
this pull request
Apr 9, 2024
* Fixes typo in Caching envvar Envvar to set caching mode was previously CLOUPATHLIB_FILE_CACHE_MODE (missing D in CLOUDPATHLIB). This commit fixes this typo and introduces some code to help migrate projects to the new envvar. The current logic for migration warnings is: - If the old envvar is set and not the new one, use the old one and issue a deprecation warning - If the old and new envvars are set, use the new version and issue a warning if the two disagree * Added deprecation version * Fully reset envvars after testing Co-authored-by: Micha Gorelick <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Envvar to set caching mode was previously CLOUPATHLIB_FILE_CACHE_MODE (missing D in CLOUDPATHLIB). This commit fixes this typo and introduces some code to help migrate projects to the new envvar. The current logic for migration warnings is:
Closes #423
Contributor checklist:
CONTRIBUTING.mdCloses #issueappears in the PR summary (e.g.,Closes #123).HISTORY.mdwith the issue that is addressed and the PR you are submitting. If the top section is not `## UNRELEASED``, then you need to add a new section to the top of the document for your change.