Skip to content

WIP: Add data sources for hosted runner custom images#3286

Draft
austenstone wants to merge 2 commits intointegrations:mainfrom
austenstone:feat/hosted-runner-custom-images
Draft

WIP: Add data sources for hosted runner custom images#3286
austenstone wants to merge 2 commits intointegrations:mainfrom
austenstone:feat/hosted-runner-custom-images

Conversation

@austenstone
Copy link
Contributor

Summary

Add three new data sources for managing custom images on GitHub-hosted runners:

Data Source API Endpoint Description
github_actions_hosted_runner_custom_images GET /orgs/{org}/actions/hosted-runners/images/custom List all custom images for an org
github_actions_hosted_runner_custom_image GET /orgs/{org}/actions/hosted-runners/images/custom/{id} Get a single custom image definition
github_actions_hosted_runner_custom_image_versions GET /orgs/{org}/actions/hosted-runners/images/custom/{id}/versions List versions of a custom image

Blocked On

Current Approach

Uses raw HTTP calls via client.NewRequest/client.Do (same pattern as the existing github_actions_hosted_runner resource) to avoid a go-github version bump until the upstream PR merges and releases.

Once go-github releases with the custom image endpoints, these data sources can be migrated to use the typed SDK methods.

What's Included

  • 3 data source implementations
  • 3 acceptance test files
  • Provider registration in provider.go
  • Website documentation for all 3 data sources

New Types from go-github PR

HostedRunnerCustomImage        // id, platform, name, source, versions_count, total_versions_size, latest_version, state
HostedRunnerCustomImageVersion // version, size_gb, state, created_on

Related

Add three new data sources for managing custom images on GitHub-hosted runners:

- github_actions_hosted_runner_custom_images: List all custom images for an org
- github_actions_hosted_runner_custom_image: Get a single custom image definition
- github_actions_hosted_runner_custom_image_versions: List versions of a custom image

WIP: Blocked on google/go-github#4101 merging. Currently uses raw HTTP calls
via the v3client to avoid a go-github version bump. Once the go-github PR
lands and is released, these can be migrated to typed SDK methods.

Includes acceptance tests, provider registration, and website docs.
@github-actions
Copy link

👋 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! 🚀

@github-actions github-actions bot added the Type: Feature New feature or request label Mar 16, 2026
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