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

Revert "Fix typo in org rulesets.repository_id" #1885

Merged
merged 1 commit into from
Sep 11, 2023

Conversation

nickfloyd
Copy link
Contributor

Reverts #1884

We'll need to drop a major release and use MigrationFuncs pattern between the schema changes so that state doesn't get messed up for consumers.

I pulled the trigger on this one too quickly. Apologies for the hassle here. I'll reopen #1884 and put a vNext label on it.

cc: @kfcampbell, @o-sama

@o-sama
Copy link
Contributor

o-sama commented Sep 11, 2023

@nickfloyd no problem, the mistake's mine. I'll get the code down for it tonight or tomorrow morning.

Copy link
Member

@kfcampbell kfcampbell 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 @nickfloyd! Apologies for my poor communication about the next version release.

@o-sama when we make breaking changes like this, first we should introduce a new schema element that's spelled correctly and mark the misspelled property as Deprecated with a message about switching to the new element.

When that's released and has a chance to "bake" for a while, then we can add a state migration function like Nick mentioned and officially cut a major version. I know this seems like a really small thing we can easily fix, but it can cause a big hassle with consumers who have existing state that this will disrupt. Hashicorp recommends we don't cut breaking changes more than once per year as a result of the state hassles.

@o-sama I love the enthusiasm and we definitely appreciate all the help so far. If you'd like to push this along, please feel free to start making changes as described above!

@kfcampbell kfcampbell merged commit 46662a5 into main Sep 11, 2023
4 checks passed
@kfcampbell kfcampbell deleted the revert-1884-fix-org-ruleset-typo branch September 11, 2023 18:15
@o-sama
Copy link
Contributor

o-sama commented Sep 11, 2023

@kfcampbell I totally agree and definitely don't want to be breaking people's existing work using what's been released. I was just hoping since the release was just a few days ago that we could get away with it 😅

I'll get the ball rolling on this with the deprecation of the typo. Thanks for the tips also!

avidspartan1 pushed a commit to avidspartan1/terraform-provider-github that referenced this pull request Feb 5, 2024
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.

3 participants