Eliminate lock file warnings when upgrading from 1.1.0 locks #2221
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
The code was written at the time only one lockfile version was being explicitly tagged (1.1.0), and all the other older ones were untagged. In introducing the 1.2.0 format for external hashes, the current version check still took place, but no provisions were made to explicitly check between older or newer versions. As such, rebar3 would warn (prompting people to upgrade) every time a lockfile on the 1.1.0 version (which is likely over 99% of those in the wild as of today) would be encountered, we'd prompt people to upgrade. This patch introduces a constant for the list of supported tagged versions for config/lock files, which allows to drop warnings when rebar3 can transparently upgrade the lock file for the user. It pre-supposes a potential "unsupported lock file" error could be added in the future if a config format is not newer but in fact explicitly deprecated. This isn't implemented but the current logic works towards making that support possible.
starbelly
approved these changes
Feb 6, 2020
tsloughter
approved these changes
Feb 6, 2020
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.
The code was written at the time only one lockfile version was being
explicitly tagged (1.1.0), and all the other older ones were untagged.
In introducing the 1.2.0 format for external hashes, the current version
check still took place, but no provisions were made to explicitly check
between older or newer versions. As such, rebar3 would warn (prompting
people to upgrade) every time a lockfile on the 1.1.0 version (which is
likely over 99% of those in the wild as of today) would be encountered,
we'd prompt people to upgrade.
This patch introduces a constant for the list of supported tagged
versions for config/lock files, which allows to drop warnings when
rebar3 can transparently upgrade the lock file for the user.
It pre-supposes a potential "unsupported lock file" error could be added
in the future if a config format is not newer but in fact explicitly
deprecated. This isn't implemented but the current logic works towards
making that support possible.