Skip to content

Add GitHub Enterprise support to the gh CLI provisioner. #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scottisloud wants to merge 2 commits into
base: main
Choose a base branch
from
+142 −2
Open

Add GitHub Enterprise support to the gh CLI provisioner. #610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44f54c5
Add GitHub Enterprise support to the gh CLI provisioner.
scottisloud Jun 4, 2026
2493ba2
fixing linting problem
scottisloud Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions plugins/github/personal_access_token.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (

"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/importer"
"github.com/1Password/shell-plugins/sdk/provision"
"github.com/1Password/shell-plugins/sdk/schema"
"github.com/1Password/shell-plugins/sdk/schema/credname"
"github.com/1Password/shell-plugins/sdk/schema/fieldname"
Expand Down Expand Up @@ -38,7 +37,7 @@ func PersonalAccessToken() schema.CredentialType {
Optional: true,
},
},
DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
DefaultProvisioner: GitHubCLIProvisioner{},
Importer: importer.TryAll(
importer.TryEnvVarPair(defaultEnvVarMapping),
importer.TryAllEnvVars(fieldname.Token, "GH_TOKEN", "GITHUB_PAT"),
Expand Down
1 change: 1 addition & 0 deletions plugins/github/personal_access_token_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ func TestPersonalAccessTokenProvisioner(t *testing.T) {
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"GH_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GITHUB_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
},
},
Expand Down
64 changes: 64 additions & 0 deletions plugins/github/provisioner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package github

import (
"context"
"strings"

"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/schema/fieldname"
)

const (
githubHost = "github.com"
localhostHost = "github.localhost"
tenancyHost = "ghe.com"
)

// GitHubCLIProvisioner provisions auth tokens using the environment variables expected by the GitHub CLI.
// GitHub.com and GitHub Enterprise Cloud (*.ghe.com) use GH_TOKEN and GITHUB_TOKEN.
// GitHub Enterprise Server uses GH_ENTERPRISE_TOKEN and GITHUB_ENTERPRISE_TOKEN with GH_HOST.
type GitHubCLIProvisioner struct{}

func (p GitHubCLIProvisioner) Provision(ctx context.Context, in sdk.ProvisionInput, out *sdk.ProvisionOutput) {
token, ok := in.ItemFields[fieldname.Token]
if !ok {
return
}

host := strings.ToLower(strings.TrimSpace(in.ItemFields[fieldname.Host]))

if usesEnterpriseToken(host) {
out.AddEnvVar("GH_ENTERPRISE_TOKEN", token)
out.AddEnvVar("GITHUB_ENTERPRISE_TOKEN", token)
if host != "" {
out.AddEnvVar("GH_HOST", host)
}
return
}

out.AddEnvVar("GH_TOKEN", token)
out.AddEnvVar("GITHUB_TOKEN", token)
if host != "" && host != githubHost {
out.AddEnvVar("GH_HOST", host)
}
}

func usesEnterpriseToken(host string) bool {
if host == "" || host == githubHost || host == localhostHost {
return false
}

return !isTenancyHost(host)
}

func isTenancyHost(host string) bool {
return strings.HasSuffix(host, "."+tenancyHost)
}

func (p GitHubCLIProvisioner) Deprovision(ctx context.Context, in sdk.DeprovisionInput, out *sdk.DeprovisionOutput) {
// Environment variables get wiped automatically when the process exits.
}

func (p GitHubCLIProvisioner) Description() string {
return "Provision GitHub CLI environment variables: GH_TOKEN, GITHUB_TOKEN, GH_ENTERPRISE_TOKEN, GITHUB_ENTERPRISE_TOKEN, GH_HOST"
}
76 changes: 76 additions & 0 deletions plugins/github/provisioner_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
package github

import (
"testing"

"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/plugintest"
"github.com/1Password/shell-plugins/sdk/schema/fieldname"
)

func TestGitHubCLIProvisioner(t *testing.T) {
plugintest.TestProvisioner(t, GitHubCLIProvisioner{}, map[string]plugintest.ProvisionCase{
"github.com": {
ItemFields: map[sdk.FieldName]string{
fieldname.Token: "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"GH_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GITHUB_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
},
},
},
"github.com with explicit host": {
ItemFields: map[sdk.FieldName]string{
fieldname.Token: "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
fieldname.Host: "github.com",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"GH_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GITHUB_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
},
},
},
"GitHub Enterprise Server": {
ItemFields: map[sdk.FieldName]string{
fieldname.Token: "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
fieldname.Host: "enterprise.github.com",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"GH_ENTERPRISE_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GITHUB_ENTERPRISE_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GH_HOST": "enterprise.github.com",
},
},
},
"GitHub Enterprise Cloud": {
ItemFields: map[sdk.FieldName]string{
fieldname.Token: "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
fieldname.Host: "company.ghe.com",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"GH_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GITHUB_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GH_HOST": "company.ghe.com",
},
},
},
"github.localhost": {
ItemFields: map[sdk.FieldName]string{
fieldname.Token: "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
fieldname.Host: "github.localhost",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"GH_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GITHUB_TOKEN": "github_pat_OYXGsaLFxgNy9msXs44LFNzg3wh0VsXRGycViVc0iKPOqczc1QKlB3ZVVrm5ESukqKR8nE3jzPBEXAMPLE",
"GH_HOST": "github.localhost",
},
},
},
})
}