feat: add github_release_asset data source by mdb · Pull Request #2514 · integrations/terraform-provider-github

mdb · 2024-12-14T12:02:12Z

This addresses issue #2513 and adds support for a github_release_asset data source.

Example of passing acceptance tests:

GITHUB_ORGANIZATION=mterwill \
GITHUB_OWNER=mterwill \
TF_ACC=1 \
  go test -v ./... -run ^TestAccGithubReleaseAssetDataSource
?       github.com/integrations/terraform-provider-github/v6    [no test files]
=== RUN   TestAccGithubReleaseAssetDataSource
=== RUN   TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID
=== RUN   TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account
    provider_utils.go:51: GITHUB_TOKEN environment variable should be empty
    provider_utils.go:74: Skipping TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account which requires anonymous mode
=== RUN   TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_individual_account
=== RUN   TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_organization_account
--- PASS: TestAccGithubReleaseAssetDataSource (11.65s)
    --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (11.65s)
        --- SKIP: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account (0.00s)
        --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_individual_account (8.90s)
        --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_organization_account (2.75s)
PASS
ok      github.com/integrations/terraform-provider-github/v6/github     12.434s

Updated testing, per feedback from @deiga :

$ TF_ACC=1 \
  go test -v ./... -run ^TestAccGithubReleaseAssetDataSource
?       github.com/integrations/terraform-provider-github/v6    [no test files]
=== RUN   TestAccGithubReleaseAssetDataSource
=== RUN   TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID
--- PASS: TestAccGithubReleaseAssetDataSource (5.91s)
    --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (5.91s)
PASS
ok      github.com/integrations/terraform-provider-github/v6/github     6.788s

Resolves #2513

Before the change?

The provider did not support a github_release_asset data source

After the change?

The provider supports a github_release_asset data source

Pull request checklist

Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

No.

Please see our docs on breaking changes to help!

Yes
No

mdb · 2025-05-04T10:48:03Z

Hi @lafrenierejm - This has been waiting on reviews for ~6 months. Is there anything I can do to help steward this along to get it reviewed, merged, and released?

mdb · 2025-05-05T17:53:21Z

Hi @kfcampbell - I believe you've merged/released other PRs. Is there anything I can do to help steward this along to get it reviewed, merged, and released? Thanks!

mdb · 2025-12-19T20:10:46Z

@deiga Given your help reviewing PR #2515, would you mind reviewing this as well? Thanks!

deiga · 2025-12-20T13:49:42Z

Hey @mdb 👋

Thanks for the contribution!

The changes look good for the most part.
I have a few requests for you:

Could you elaborate the headers change? The comment wasn't enough for me to understand what is happening.
I wonder if it'd be possible to get a test for the headers change which ensures that it doesn't break any behaviour?
We're moving towards Context-aware provider functions, could you refactor the Schemata to use ReadContext?
We're also going to start using documentation generating from resource/data source Descriptions. Could you ensure that all necessary info is in the different Description fields of the Schemata?

@deiga

Per request of @deiga (integrations#2514 (comment)), this adds tests for previewHeaderInjectorTransport.RoundTrip logic around application/octest-stream header handling. See google/go-github#3392 for context. Signed-off-by: Mike Ball <mikedball@gmail.com>

mdb · 2025-12-21T12:21:39Z

Thanks for the quick response @deiga !

Could you elaborate the headers change? The comment wasn't enough for me to understand what is happening.

I've added a comment linking to corresponding context over in google/go-github#3392 (and note that this is fixed in go-github/v68 (Admittedly, this is all a bit foggy for me -- it's been over a year since I opened this PR as well as since I opened google/go-github#3392)).

I wonder if it'd be possible to get a test for the headers change which ensures that it doesn't break any behaviour?

I added unit tests. Does that address your concern?

We're moving towards Context-aware provider functions, could you refactor the Schemata to use ReadContext?

Done!

We're also going to start using documentation generating from resource/data source Descriptions. Could you ensure that all necessary info is in the different Description fields of the Schemata?

Done!

mdb · 2026-01-04T18:25:45Z

@deiga 👋 Gentle nudge! Have I addressed your concerns in the response above?

deiga · 2026-01-05T08:14:55Z

@mdb Thanks for the changes! These look good!

I realized that this PR won't land at least before v6.10.0 and there is a major test refactor coming in there. Would you be available to rebase on top of #2986 and conform your TestAcc* with those changes?

@deiga

Per request of @deiga (integrations#2514 (comment)), this adds tests for previewHeaderInjectorTransport.RoundTrip logic around application/octest-stream header handling. See google/go-github#3392 for context. Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

Per code review feedback from @deiga (integrations#2514 (comment)), this updates the github_release_asset data source tests to use the new testing patterns implemented in integrations#2986 This was tested via: ``` $ TF_ACC=1 \ go test -v ./... -run ^TestAccGithubReleaseAssetDataSource ? github.com/integrations/terraform-provider-github/v6 [no test files] === RUN TestAccGithubReleaseAssetDataSource === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID --- PASS: TestAccGithubReleaseAssetDataSource (5.91s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (5.91s) PASS ok github.com/integrations/terraform-provider-github/v6/github 6.788s ``` Signed-off-by: Mike Ball <mikedball@gmail.com>

mdb · 2026-01-08T14:40:12Z

@mdb Thanks for the changes! These look good!

I realized that this PR won't land at least before v6.10.0 and there is a major test refactor coming in there. Would you be available to rebase on top of #2986 and conform your TestAcc* with those changes?

@deiga Thanks! I pushed a commit doing so. How's that look?

@deiga

Per request of @deiga (integrations#2514 (comment)), this adds tests for previewHeaderInjectorTransport.RoundTrip logic around application/octest-stream header handling. See google/go-github#3392 for context. Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

Per code review feedback from @deiga (integrations#2514 (comment)), this updates the github_release_asset data source tests to use the new testing patterns implemented in integrations#2986 This was tested via: ``` $ TF_ACC=1 \ go test -v ./... -run ^TestAccGithubReleaseAssetDataSource ? github.com/integrations/terraform-provider-github/v6 [no test files] === RUN TestAccGithubReleaseAssetDataSource === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID --- PASS: TestAccGithubReleaseAssetDataSource (5.91s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (5.91s) PASS ok github.com/integrations/terraform-provider-github/v6/github 6.788s ``` Signed-off-by: Mike Ball <mikedball@gmail.com>

github/data_source_github_release_asset_test.go

@deiga

Per request of @deiga (integrations#2514 (comment)), this adds tests for previewHeaderInjectorTransport.RoundTrip logic around application/octest-stream header handling. See google/go-github#3392 for context. Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

Per code review feedback from @deiga (integrations#2514 (comment)), this updates the github_release_asset data source tests to use the new testing patterns implemented in integrations#2986 This was tested via: ``` $ TF_ACC=1 \ go test -v ./... -run ^TestAccGithubReleaseAssetDataSource ? github.com/integrations/terraform-provider-github/v6 [no test files] === RUN TestAccGithubReleaseAssetDataSource === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID --- PASS: TestAccGithubReleaseAssetDataSource (5.91s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (5.91s) PASS ok github.com/integrations/terraform-provider-github/v6/github 6.788s ``` Signed-off-by: Mike Ball <mikedball@gmail.com>

deiga

LGTM! @stevehipwell what do you think about the test variable additions?

stevehipwell

Thanks for the PR @mdb, I've added some review comments.

github/data_source_github_release_asset.go

github/data_source_github_release_asset_test.go

@deiga

Per request of @deiga (integrations#2514 (comment)), this adds tests for previewHeaderInjectorTransport.RoundTrip logic around application/octest-stream header handling. See google/go-github#3392 for context. Signed-off-by: Mike Ball <mikedball@gmail.com>

stevehipwell · 2026-01-28T15:00:08Z

@mdb it looks like you've got failing tests.

mdb · 2026-01-28T19:24:10Z

@mdb it looks like you've got failing tests.

@stevehipwell Doh, thanks! I've pushed a fix.

stevehipwell

LGTM

stevehipwell · 2026-01-29T12:06:33Z

@mdb could you please rebase this so we can get it merged?

This addresses issue integrations#2513 and adds support for a `github_release_asset` data source. Example of passing acceptance tests: ``` GITHUB_ORGANIZATION=mterwill \ GITHUB_OWNER=mterwill \ TF_ACC=1 \ go test -v ./... -run ^TestAccGithubReleaseAssetDataSource ? github.com/integrations/terraform-provider-github/v6 [no test files] === RUN TestAccGithubReleaseAssetDataSource === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account provider_utils.go:51: GITHUB_TOKEN environment variable should be empty provider_utils.go:74: Skipping TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account which requires anonymous mode === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_individual_account === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_organization_account --- PASS: TestAccGithubReleaseAssetDataSource (11.65s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (11.65s) --- SKIP: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account (0.00s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_individual_account (8.90s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_organization_account (2.75s) PASS ok github.com/integrations/terraform-provider-github/v6/github 12.434s ``` Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

Per request of @deiga (integrations#2514 (comment)), this adds tests for previewHeaderInjectorTransport.RoundTrip logic around application/octest-stream header handling. See google/go-github#3392 for context. Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

Per code review feedback from @deiga (integrations#2514 (comment)), this updates the github_release_asset data source tests to use the new testing patterns implemented in integrations#2986 This was tested via: ``` $ TF_ACC=1 \ go test -v ./... -run ^TestAccGithubReleaseAssetDataSource ? github.com/integrations/terraform-provider-github/v6 [no test files] === RUN TestAccGithubReleaseAssetDataSource === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID --- PASS: TestAccGithubReleaseAssetDataSource (5.91s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (5.91s) PASS ok github.com/integrations/terraform-provider-github/v6/github 6.788s ``` Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

…l pattern Per code review feedback (integrations#2514 (comment)) from @stevehipwell, this tweaks the `data_source_github_release_asset` to use the `if err := ...; err != nil` pattern towards the goal of improving readability. Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

Use idiomatic `:=` pattern over `var`-pre-defined variables, per code review feedback from @stevehipwell: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

…Func This inlines `resource.ComposeTestCheckFunc` to improve readability (rather than define it as a variable), per code review feedback from @stevehipwell: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

Per code review feedback from @stevehipwell, this simplifies test configuration: - source test configuration from `testAccConf`, as done elsewhere - remove the ability to override test configuration via `GH_TEST_*` env vars; this is arguably premature optimization and can be added to `acc_test.go` if it's needed in the future Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

…Providers Per code review feedback from @deiga, this removes unnecessary Providers configuration from the data_source_github_release_asset tests. integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

@deiga

To protect against the possibility that release asset IDs are not globally unique across GitHub, this configures the use of a 3-part composite ID when tracking `data_source_github_release_asset` instances in TF state. This addresses code review feedback from @deiga: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

Per code review feedback from @stevehipwell (integrations#2514 (comment)), this avoids the use of `client.Repositories.DownloadReleaseAsset` out of concern the function modifies the GitHub client state which could cause unexpected behaviour in Terraform. Signed-off-by: Mike Ball <mikedball@gmail.com>

This fixes a copy/paste bug; updated_at is now correctly set on the data source. Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

Per code review feedback from @stevehipwell (integrations#2514 (review)), this makes the release asset download optional, controlled by a `download_body` attribute, and off by default. Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

…ttributes Replace `download_body` argument and `body` attributes w/ `download_file`/`file`, respectively, towards the goal of improving the data source interface. This addresses code review feedback from @stevehipwell: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

Per code review feedback from @stevehipwell (integrations#2514 (comment)), this ensures `file` is base64-encoded. Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

Per code review feedback from @stevehipwell, this changes `download_file`/`file` to `download_file_contents`/`file_contents`, respectively: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

@stevehipwell

This improves the `data_source_github_release_asset` acceptance tests to be more TF-focused via use of the `base64decode` function, per code review request of @stevehipwell: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

This commits the result of `gofumpt`, as per lint failures in: https://github.com/integrations/terraform-provider-github/actions/runs/21232219897/job/61621068985?pr=2514 Signed-off-by: Mike Ball <mikedball@gmail.com>

This appeases lint warnings in `github/config_test.go`: https://github.com/integrations/terraform-provider-github/actions/runs/21232219897/job/61621068985?pr=2514 Signed-off-by: Mike Ball <mikedball@gmail.com>

This addresses the following staticcheck error (seen in https://github.com/integrations/terraform-provider-github/actions/runs/21232219897/job/61621068985?pr=2514): ``` Error: github/config.go:196:13: QF1001: could apply De Morgan's law (staticcheck) ``` Signed-off-by: Mike Ball <mikedball@gmail.com>

Go's http.Header canonicalizes header names (e.g., X-GitHub-Api-Version becomes X-Github-Api-Version). The test's unexpected header check was failing because it compared canonical names against non-canonical keys in the expectedHeaders map. Signed-off-by: Mike Ball <mikedball@gmail.com>

mdb · 2026-01-29T13:04:53Z

@mdb could you please rebase this so we can get it merged?

@stevehipwell Done!

felipebraga

I'll open a new PR removing it.

felipebraga · 2026-02-12T15:09:31Z

github/data_source_github_release_asset.go

+		return diag.FromErr(err)
+	}
+
+	req.Header.Set("Accept", "application/octet-stream")


Set and Accept header causes the http request to return 406 Not Acceptable.

req.Header.Set("Accept", "application/octet-stream")

Suggested change

req.Header.Set("Accept", "application/octet-stream")

felipebraga · 2026-02-12T15:10:59Z

website/docs/d/release_asset.html.markdown

+    repository    = "example-repository"
+    owner         = "example-owner"
+    asset_id      = 12345
+    download_file = true


Suggested change

download_file = true

download_file_contents = true

mdb force-pushed the mdb/gh-release-asset branch from dac6b1b to 696957f Compare December 17, 2024 13:27

mdb marked this pull request as ready for review December 17, 2024 13:28

mdb mentioned this pull request May 5, 2025

[FEAT]: Support github_release_asset data source #2513

Closed

1 task

mdb force-pushed the mdb/gh-release-asset branch from 5ba605e to 0671ab4 Compare December 19, 2025 19:57

mdb force-pushed the mdb/gh-release-asset branch 2 times, most recently from 9b364b5 to 2407ae3 Compare December 21, 2025 11:58

mdb force-pushed the mdb/gh-release-asset branch from d5e51a6 to 0cdd8e1 Compare January 8, 2026 14:38

mdb force-pushed the mdb/gh-release-asset branch from 0cdd8e1 to 102ba5d Compare January 8, 2026 14:40

deiga reviewed Jan 8, 2026

View reviewed changes

github/data_source_github_release_asset_test.go Outdated Show resolved Hide resolved

mdb force-pushed the mdb/gh-release-asset branch from 102ba5d to 83ab3d7 Compare January 9, 2026 13:12

mdb requested a review from deiga January 9, 2026 13:12

deiga approved these changes Jan 9, 2026

View reviewed changes

stevehipwell requested changes Jan 12, 2026

View reviewed changes

github-project-automation bot moved this from 👀 In review to 🏗 In progress in 🧰 Octokit Active Jan 12, 2026

mdb requested a review from stevehipwell January 27, 2026 18:16

stevehipwell approved these changes Jan 28, 2026

View reviewed changes

nickfloyd approved these changes Jan 28, 2026

View reviewed changes

mdb added 20 commits January 29, 2026 08:04

chore(data_source_github_release_asset): improve terseness

44ea634

Use idiomatic `:=` pattern over `var`-pre-defined variables, per code review feedback from @stevehipwell: integrations#2514 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>

fix(data_source_github_release_asset): properly set updated_at

28896b1

This fixes a copy/paste bug; updated_at is now correctly set on the data source. Signed-off-by: Mike Ball <mikedball@gmail.com>

fix(data_source_github_release_asset): base64 encode file

aeabad4

Per code review feedback from @stevehipwell (integrations#2514 (comment)), this ensures `file` is base64-encoded. Signed-off-by: Mike Ball <mikedball@gmail.com>

chore(config_test): appease lint errors

e0eb14b

This appeases lint warnings in `github/config_test.go`: https://github.com/integrations/terraform-provider-github/actions/runs/21232219897/job/61621068985?pr=2514 Signed-off-by: Mike Ball <mikedball@gmail.com>

deiga mentioned this pull request Feb 3, 2026

[MAINT] Migrate all resources and data sources to Context-aware CRUD functions #2996

Open

felipebraga reviewed Feb 12, 2026

View reviewed changes

felipebraga mentioned this pull request Feb 12, 2026

fix(data_source_github_release_asset): Fix #2514 remove accept header… #3186

Open

4 tasks

Conversation

mdb commented Dec 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Updated testing, per feedback from @deiga :

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

mdb commented May 4, 2025

Uh oh!

mdb commented May 5, 2025

Uh oh!

mdb commented Dec 19, 2025

Uh oh!

deiga commented Dec 20, 2025

Uh oh!

mdb commented Dec 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mdb commented Jan 4, 2026

Uh oh!

deiga commented Jan 5, 2026

Uh oh!

mdb commented Jan 8, 2026

Uh oh!

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell commented Jan 28, 2026

Uh oh!

mdb commented Jan 28, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell commented Jan 29, 2026

Uh oh!

mdb commented Jan 29, 2026

Uh oh!

felipebraga left a comment

Choose a reason for hiding this comment

Uh oh!

felipebraga Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

felipebraga Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mdb commented Dec 14, 2024 •

edited

Loading

mdb commented Dec 21, 2025 •

edited

Loading