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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cache): adds cache format version & checks against it #891

Merged
merged 6 commits into from Dec 18, 2023

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Dec 18, 2023

Description

  • adds a cache format version attribute
  • adds a check to skip using the cache when the version found in the cache is too low
  • makes the typescript typings in some of the cache related modules a bit more readable (and valid).

Motivation and Context

There are some changes in the dependency-cruiser output format that are incompatible between version 15 and 16. For use without a cache (or known violations, but see #890 for that) this presents no issues. The cache can still contain the old format, though, which might result in slightly unexpected output or disturbing looking errors. With this feature dependency-cruiser will ignore the contents of the cache when the format version of that cache is too low.

How Has This Been Tested?

  • green ci
  • additional non-regression tests

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation only change
  • Refactor (non-breaking change which fixes an issue without changing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • 馃摉

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • 鈿栵笍

    • The contribution will be subject to The MIT license, and I'm OK with that.
    • The contribution is my own original work.
    • I am ok with the stuff in CONTRIBUTING.md.

Copy link

codeclimate bot commented Dec 18, 2023

Code Climate has analyzed commit 7de8775 and detected 0 issues on this pull request.

View more on Code Climate.

@sverweij sverweij merged commit 7ddf2db into main Dec 18, 2023
9 checks passed
@sverweij sverweij deleted the feature/adds-cache-version-number branch December 18, 2023 17:19
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.

None yet

1 participant