Fix: prevent unexpected status check contexts deletion for archived repositories#3305
Open
hanyouqing wants to merge 1 commit intointegrations:mainfrom
Open
Conversation
This file contains hidden or 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
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.
Resolves #3306
This PR addresses an issue where archiving a repository would cause Terraform to show a plan diff to delete
the contexts field in github_branch_protection and github_branch_protection_v3 resources, even when status
checks are still active via the newer checks API.
Before the change?
field but continues to return it in the checks array. Since contexts is Computed, the provider detects
this as a deletion in the state.
populated by the API but absent from the user's HCL configuration.
After the change?
automatically populate the contexts state from the checks array if the legacy contexts field is empty.
This keeps the legacy field in sync with the actual status checks.
github/resource_github_branch_protection.go. This prevents Terraform from seeing the field as drift that
needs to be "corrected" (deleted) when not explicitly specified in the configuration.
Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!