Set commit info using create or update #466
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
Due to how the read func was written Terraform will try to find the commit info each time it does a refresh. As you cannot get this info easily from the GitHub API, the provider would loop through commits until it found one containing the file in question. When the commit is a a distant memory, it can incur many API requests and, when managing many files across many repositories, could result in being rate limited. To address this instead we now set this info when the file is created or updated and not during the refresh. This is pretty safe as for this info to change upstream it would mean changing the file contents, which would trigger Terraform to update the file again (to enforce desired state). Signed-off-by: Stephen Hoekstra <shoekstra@schubergphilis.com>
ghost
added
the
Signed-off-by: Stephen Hoekstra <shoekstra@schubergphilis.com>
jcudit
approved these changes
May 18, 2020
jcudit
approved these changes
Jun 9, 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.
Due to how the read func was written Terraform will try to find the commit info each time it does a refresh. As you cannot get this info easily from the GitHub API, the provider would loop through commits until it found one containing the file in question. When the commit is a a distant memory, it can incur many API requests and, when managing many files across many repositories, could result in being rate limited.
To address this instead we now set this info when the file is created or updated and not during the refresh. This is pretty safe as for this info to change upstream it would mean changing the file contents, which would trigger Terraform to update the file again (to enforce desired state).