Skip to content

feat: read timeout for github_ip_ranges data source#3421

Open
ffreitas-te wants to merge 1 commit into
integrations:mainfrom
ffreitas-te:feat/github-ip-ranges-read-timeout
Open

feat: read timeout for github_ip_ranges data source#3421
ffreitas-te wants to merge 1 commit into
integrations:mainfrom
ffreitas-te:feat/github-ip-ranges-read-timeout

Conversation

@ffreitas-te
Copy link
Copy Markdown

@ffreitas-te ffreitas-te commented May 12, 2026

Before the change?

  • The github_ip_ranges data source had no timeouts block, and the metadata request used owner.StopContext instead of the Terraform read context, so a read timeout would not reliably bound the HTTP call.

After the change?

  • Default 5 minute read timeout on github_ip_ranges (overridable via timeouts { read = "..." } in configuration).
  • The metadata API call uses the ReadContext ctx, so Terraform's read deadline is honored.

Pull request checklist

  • Schema migrations have been created if needed (example)
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Schema migrations: N/A — this updates only the github_ip_ranges data source; no managed resource identity or Terraform state schema changes, so no migration code is required.

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

Related to #1961
Follow-up to #1978 (previous change went stale; this re-applies the same intent on the current Terraform Plugin SDK v2 codebase.)

/cc @kimxogus @kfcampbell @KatKorotkikh

Apply a default 5m read timeout and use the Terraform read context for the
metadata API call so the timeout is enforced.

Reintroduces the intent of the prior stale PR for configurable read timeouts.

Refs: integrations#1961 integrations#1978
@github-actions github-actions Bot added the Type: Feature New feature or request label May 12, 2026
@github-actions
Copy link
Copy Markdown

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@ffreitas-te
Copy link
Copy Markdown
Author

Bumping for visibility: this addresses the long-running github_ip_ranges read behavior described in #1961 (timeouts + using the read context for the metadata call).

@KatKorotkikh — same class of pain as in #1961; feel free to weigh in if this matches what you hit in practice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant