gh codespace commands now respect the following environment variables: - GITHUB_SERVER_URL: typically "https://github.com" - GITHUB_API_URL: typically "https://api.github.com" - INTERNAL_VSCS_TARGET_URL: typically "https://online.visualstudio.com" - GITHUB_TOKEN when CODESPACES is set, even if the host connecting to isn't "github.com". This set of changes ensures that `gh codespace` commands automatically connect to the right API endpoints when gh is used within a codespace. Co-authored-by: Mislav Marohnić <mislav@github.com>
126 lines
2.9 KiB
Go
126 lines
2.9 KiB
Go
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strconv"
|
|
|
|
"github.com/cli/cli/v2/internal/ghinstance"
|
|
)
|
|
|
|
const (
|
|
GH_HOST = "GH_HOST"
|
|
GH_TOKEN = "GH_TOKEN"
|
|
GITHUB_TOKEN = "GITHUB_TOKEN"
|
|
GH_ENTERPRISE_TOKEN = "GH_ENTERPRISE_TOKEN"
|
|
GITHUB_ENTERPRISE_TOKEN = "GITHUB_ENTERPRISE_TOKEN"
|
|
CODESPACES = "CODESPACES"
|
|
)
|
|
|
|
type ReadOnlyEnvError struct {
|
|
Variable string
|
|
}
|
|
|
|
func (e *ReadOnlyEnvError) Error() string {
|
|
return fmt.Sprintf("read-only value in %s", e.Variable)
|
|
}
|
|
|
|
func InheritEnv(c Config) Config {
|
|
return &envConfig{Config: c}
|
|
}
|
|
|
|
type envConfig struct {
|
|
Config
|
|
}
|
|
|
|
func (c *envConfig) Hosts() ([]string, error) {
|
|
hasDefault := false
|
|
hosts, err := c.Config.Hosts()
|
|
for _, h := range hosts {
|
|
if h == ghinstance.Default() {
|
|
hasDefault = true
|
|
}
|
|
}
|
|
token, _ := AuthTokenFromEnv(ghinstance.Default())
|
|
if (err != nil || !hasDefault) && token != "" {
|
|
hosts = append([]string{ghinstance.Default()}, hosts...)
|
|
return hosts, nil
|
|
}
|
|
return hosts, err
|
|
}
|
|
|
|
func (c *envConfig) DefaultHost() (string, error) {
|
|
val, _, err := c.DefaultHostWithSource()
|
|
return val, err
|
|
}
|
|
|
|
func (c *envConfig) DefaultHostWithSource() (string, string, error) {
|
|
if host := os.Getenv(GH_HOST); host != "" {
|
|
return host, GH_HOST, nil
|
|
}
|
|
return c.Config.DefaultHostWithSource()
|
|
}
|
|
|
|
func (c *envConfig) Get(hostname, key string) (string, error) {
|
|
val, _, err := c.GetWithSource(hostname, key)
|
|
return val, err
|
|
}
|
|
|
|
func (c *envConfig) GetWithSource(hostname, key string) (string, string, error) {
|
|
if hostname != "" && key == "oauth_token" {
|
|
if token, env := AuthTokenFromEnv(hostname); token != "" {
|
|
return token, env, nil
|
|
}
|
|
}
|
|
|
|
return c.Config.GetWithSource(hostname, key)
|
|
}
|
|
|
|
func (c *envConfig) CheckWriteable(hostname, key string) error {
|
|
if hostname != "" && key == "oauth_token" {
|
|
if token, env := AuthTokenFromEnv(hostname); token != "" {
|
|
return &ReadOnlyEnvError{Variable: env}
|
|
}
|
|
}
|
|
|
|
return c.Config.CheckWriteable(hostname, key)
|
|
}
|
|
|
|
func AuthTokenFromEnv(hostname string) (string, string) {
|
|
if ghinstance.IsEnterprise(hostname) {
|
|
if token := os.Getenv(GH_ENTERPRISE_TOKEN); token != "" {
|
|
return token, GH_ENTERPRISE_TOKEN
|
|
}
|
|
|
|
if token := os.Getenv(GITHUB_ENTERPRISE_TOKEN); token != "" {
|
|
return token, GITHUB_ENTERPRISE_TOKEN
|
|
}
|
|
|
|
if isCodespaces, _ := strconv.ParseBool(os.Getenv(CODESPACES)); isCodespaces {
|
|
return os.Getenv(GITHUB_TOKEN), GITHUB_TOKEN
|
|
}
|
|
|
|
return "", ""
|
|
}
|
|
|
|
if token := os.Getenv(GH_TOKEN); token != "" {
|
|
return token, GH_TOKEN
|
|
}
|
|
|
|
return os.Getenv(GITHUB_TOKEN), GITHUB_TOKEN
|
|
}
|
|
|
|
func AuthTokenProvidedFromEnv() bool {
|
|
return os.Getenv(GH_ENTERPRISE_TOKEN) != "" ||
|
|
os.Getenv(GITHUB_ENTERPRISE_TOKEN) != "" ||
|
|
os.Getenv(GH_TOKEN) != "" ||
|
|
os.Getenv(GITHUB_TOKEN) != ""
|
|
}
|
|
|
|
func IsHostEnv(src string) bool {
|
|
return src == GH_HOST
|
|
}
|
|
|
|
func IsEnterpriseEnv(src string) bool {
|
|
return src == GH_ENTERPRISE_TOKEN || src == GITHUB_ENTERPRISE_TOKEN
|
|
}
|