mimirtool: deprecate rule-files flag #7756
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
The flag is unnecessary since it is an argument in all updated commands.
|
|
We should issue a deprecation notice before deleting the flag (and it's functionality): https://github.com/grafana/mimir/blob/main/docs/sources/mimir/configure/about-versioning.md#deprecated-features And then we should keep it for 2 versions more, otherwise we might break people's CI workflows. |
This reverts commit c82d2e0.
armandgrillet
changed the title
|
@colega Thanks for the review, PR updated to only deprecate the flags. |
colega
reviewed
Apr 1, 2024
colega
reviewed
Apr 1, 2024
colega
reviewed
Apr 1, 2024
colega
reviewed
Apr 4, 2024
Co-authored-by: Oleg Zaytsev <mail@olegzaytsev.com>
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.
What this PR does
A few
mimirtoolcommands accepted arule-filesflag:rules diff,rules sync,rules prepare,rules lint, andrules check. However, all these commands also accept a list of rule files as argument. Therefore, the flag is a duplicate which is inconsistent.This flag originated in 9b206ce. Back then, the list of rule files was only an argument for one command:
rules load, and that command never got arule-filesflag. The rule files argument was added later to more commands, in https://github.com/grafana/cortex-tools/pull/125/files, but the existingrule-filesflag was not removed.This will be a breaking change for folks relying on
mimirtoolin scripts, for now the flag is only deprecated.Which issue(s) this PR fixes or relates to
Fixes #6747
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.