feat!: Add OIDC authentication support to `PrivateRegistries` by mkushakov · Pull Request #4159 · google/go-github

mkushakov · 2026-04-16T11:32:14Z

BREAKING CHANGE: PrivateRegistriesService is updated to API version 2026-03-10 with struct and response changes.

Update the PrivateRegistriesService to align with the GitHub Private Registries
API version 2026-03-10.

Changes:

Add PrivateRegistryAuthType type with constants for token, username_password,
oidc_azure, oidc_aws, and oidc_jfrog
Add OIDC-related fields to CreateOrganizationPrivateRegistry and
UpdateOrganizationPrivateRegistry: AuthType, TenantID, ClientID,
AWSRegion, AccountID, RoleName, Domain, DomainOwner,
JFrogOIDCProviderName , Audience, IdentityMappingName
Add ReplacesBase field to both Create and Update request structs
Add SelectedRepositoryIDs field to PrivateRegistry response struct
Change EncryptedValue and KeyID in CreateOrganizationPrivateRegistry
to *string with omitempty (should be omitted for OIDC auth types)
Change UpdateOrganizationPrivateRegistry() to return (*Response, error)
since the API now returns 204 No Content

API docs: https://docs.github.com/rest/private-registries/organization-configurations?apiVersion=2026-03-10

Fixes: #4158.

google-cla · 2026-04-16T11:32:19Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

codecov · 2026-04-16T12:19:18Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.70%. Comparing base (971b607) to head (c1c83da).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4159      +/-   ##
==========================================
- Coverage   93.70%   93.70%   -0.01%     
==========================================
  Files         210      210              
  Lines       19692    19688       -4     
==========================================
- Hits        18453    18449       -4     
  Misses       1045     1045              
  Partials      194      194

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

mkushakov · 2026-04-16T13:31:49Z

@gmlewis thanks for initial review, but this PR is breaking change compared to master branch, not to latest release, since github/private_registries.go was introduced recently and was not yet released #4147
this is why it will be better to merge it before release, to avoid breaking changes

gmlewis

Thank you, @mkushakov!
This is the first GitHub v3 API version breaking change using their new "calendar-versioning" mechanism. As a result, we need to make some more changes in this PR.

According to our README.md:

### Calendar Versioning ###

As of 2022-11-28, GitHub has announced (broken link)
that they are starting to version their v3 API based on "calendar-versioning".

In practice, our goal is to make per-method version overrides (at
least in the core library) rare and temporary.

Our understanding of the GitHub docs is that they will be revving the
entire API to each new date-based version, even if only a few methods
have breaking changes. Other methods will accept the new version with
their existing functionality. So when a new date-based version of the
GitHub API is released, we (the repo maintainers) plan to:

* update each method that had breaking changes, overriding their
  per-method API version header. This may happen in one or multiple
  commits and PRs, and is all done in the main branch.

* once all of the methods with breaking changes have been updated,
  have a final commit that bumps the default API version, and remove
  all of the per-method overrides. That would now get a major version
  bump when the next go-github release is made.

So we need to override the per-method API version header in this PR according to the blog post, and I'm discovering that the blog post link is now broken.
The new link is:
https://github.blog/developer-skills/github/to-infinity-and-beyond-enabling-the-future-of-githubs-rest-api-with-api-versioning/

According to the blog post, the following header needs to be added to the updated endpoint:

X-GitHub-Api-Version: 2026-03-10

So this endpoint needs to add:

req.Header.Set(headerAPIVersion, "2026-03-10")

Not-Dhananjay-Mishra · 2026-04-17T15:27:24Z

 	input := &CreateOrganizationPrivateRegistry{
-		RegistryType:          "maven_repository",
+		RegistryType:          PrivateRegistryTypeMavenRepository,
 		URL:                   "https://maven.pkg.github.com/OWNER/REPOSITORY",


@gmlewis Should we also change this URL? I ignore that in #3948 because it has github.com

@gmlewis Should we also change this URL? I ignore that in #3948 because it has github.com

Yes, please change this URL to example.com for consistency with the rest of this repo, @mkushakov.
Thank you!

let me know if you want me to replace it as part of my PR as well

let me know if you want me to replace it as part of my PR as well

Yes, please do that in this PR.
Thank you 🙂

fixed 0070051

gmlewis · 2026-04-17T15:38:14Z

@gmlewis thanks for initial review, but this PR is breaking change compared to master branch, not to latest release, since github/private_registries.go was introduced recently and was not yet released #4147 this is why it will be better to merge it before release, to avoid breaking changes

Thank you, @mkushakov! That does make sense.

However, I like to keep track of all breaking changes as we move through the release cycles for those people who are following all the changes as they happen, so let's leave this labeled as a breaking change... at the very least, it will alert those who worked on github/private_registries.go that their original implementation has breaking changes since they wrote it, which should help minimize any unnecessary surprises.

…e registry models

…ing private registries

…ry requests

…s and update accessors

…for consistency

… update test

… for AWS and JFrog OIDC provider

alexandear · 2026-04-20T10:36:56Z

We need to somehow update the generated docs for all changed endpoints (2026-03-10 instead of 2022-11-28):

// GitHub API docs: https://docs.github.com/rest/private-registries/organization-configurations?apiVersion=2026-03-10#list-private-registries-for-an-organization

Take a look at the tools/metadata/metadata.go.

good catch, i have changed tools/metadata/metadata.go to preserve an existing api version if set, and use default 2022-11-28 if not set on resource 7179334

…Registry to use example.com

…rivate registries

gmlewis · 2026-04-20T14:52:05Z

We try to keep the yaml updates in separate, focused PRs, so I will work on that later today and we can merge that change into this PR to also keep this one focused.

gmlewis changed the title ~~feat: Add OIDC authentication support to PrivateRegistries~~ feat: Add OIDC authentication support to PrivateRegistries Apr 16, 2026

gmlewis added the NeedsReview PR is awaiting a review before merging. label Apr 16, 2026

gmlewis changed the title ~~feat: Add OIDC authentication support to PrivateRegistries~~ feat!: Add OIDC authentication support to PrivateRegistries Apr 16, 2026

gmlewis added the Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). label Apr 16, 2026

gmlewis requested changes Apr 16, 2026

View reviewed changes

gmlewis mentioned this pull request Apr 16, 2026

docs: Fix broken blog post link #4160

Merged

mkushakov force-pushed the feat/private-registry-oidc-support branch from c4bdd0e to b15fc0c Compare April 16, 2026 14:25

Not-Dhananjay-Mishra reviewed Apr 16, 2026

View reviewed changes

mkushakov force-pushed the feat/private-registry-oidc-support branch from da81ba9 to a84603b Compare April 17, 2026 07:26

Not-Dhananjay-Mishra reviewed Apr 17, 2026

View reviewed changes

alexandear suggested changes Apr 20, 2026

View reviewed changes

Comment thread github/private_registries.go Outdated

Comment thread github/private_registries.go Outdated

Comment thread github/private_registries.go Outdated

mkushakov added 8 commits April 20, 2026 12:26

feat(private-registry): add OIDC support and related fields in privat…

5a7895f

…e registry models

feat(private-registry): add OIDC support tests for creating and updat…

2ebcf85

…ing private registries

feat(private-registry): add API versioning support for private regist…

83a3281

…ry requests

feat(private-registry): enhance private registry model with new field…

66a76af

…s and update accessors

refactor(private-registry): simplify accessors and update test cases …

64ee7be

…for consistency

fix(private-registry): update audience value in OIDC private registry…

cc00714

… update test

feat(structfield): add support for additional initialisms in linter

a3026a3

refactor(private-registry): standardize field names to use camel case…

c1c83da

… for AWS and JFrog OIDC provider

mkushakov force-pushed the feat/private-registry-oidc-support branch from b864ebc to c1c83da Compare April 20, 2026 10:26

alexandear reviewed Apr 20, 2026

View reviewed changes

mkushakov added 2 commits April 20, 2026 16:26

test(private-registry): update test URL for CreateOrganizationPrivate…

0070051

…Registry to use example.com

fix(private-registry): update API version in documentation URLs for p…

7179334

…rivate registries

Conversation

mkushakov commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-cla bot commented Apr 16, 2026

Uh oh!

codecov bot commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mkushakov commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Not-Dhananjay-Mishra Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

gmlewis Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

mkushakov Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Not-Dhananjay-Mishra Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

mkushakov Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Apr 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alexandear Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

mkushakov Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mkushakov commented Apr 16, 2026 •

edited

Loading

codecov bot commented Apr 16, 2026 •

edited

Loading

mkushakov commented Apr 16, 2026 •

edited

Loading