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

Adding support for new config name #2101

Merged
merged 9 commits into from
Jun 15, 2022
Merged

Conversation

gubjanos
Copy link
Contributor

@gubjanos gubjanos commented Jun 14, 2022

What this PR does

In #1188 the config name of active_series_custom_trackers has been changed to active_series_custom_trackers_config by accident. The aim of this PR is to change it back to ąctive_series_custom_trackers while supporting the suffixed version for 2 releases.

When both are specified, the old config takes precedence.

Which issue(s) this PR fixes or relates to

Fixes #

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@gubjanos gubjanos requested a review from pstibrany June 14, 2022 12:04
@gubjanos gubjanos marked this pull request as draft June 14, 2022 12:04
@gubjanos gubjanos marked this pull request as ready for review June 15, 2022 07:50
Copy link
Member

@pstibrany pstibrany left a comment

Choose a reason for hiding this comment

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

Thank you for this!

Since this change will be released in Mimir 2.2, we can only remove old field in Mimir 2.4. Let's keep only single TODO (next to ActiveSeriesCustomTrackersConfigOld field) for removal, and drop other TODOs. Compilation errors will show us what to change.

pkg/util/validation/limits.go Outdated Show resolved Hide resolved
pkg/util/validation/limits.go Outdated Show resolved Hide resolved
pkg/util/validation/limits_test.go Outdated Show resolved Hide resolved
pkg/util/validation/limits_test.go Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@pstibrany pstibrany left a comment

Choose a reason for hiding this comment

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

Thank you.

CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Peter Štibraný <pstibrany@gmail.com>
@pstibrany pstibrany merged commit 0477cc1 into main Jun 15, 2022
@pstibrany pstibrany deleted the jg/custom-trackers-rename branch June 15, 2022 10:59
masonmei pushed a commit to udmire/mimir that referenced this pull request Jul 11, 2022
* Adding support for new config name

* Hiding documentation of active_series_custom_trackers_config, but still supporting it at deserialization time

* Clearing old config value, and adding a test case for this behaviour

* Running make reference-help

* Adding changelog describing change

* Addressing Peter's comments

* Tidying up testcases

* Removing omitempty, as its behaviour is unexpected (not serializing the object at all)

* Update CHANGELOG.md

Co-authored-by: Peter Štibraný <pstibrany@gmail.com>

Co-authored-by: Peter Štibraný <pstibrany@gmail.com>
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.

2 participants