1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
|
package set
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
"strings"
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/variable/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/hashicorp/go-multierror"
"github.com/joho/godotenv"
"github.com/spf13/cobra"
)
type iprompter interface {
Input(string, string) (string, error)
}
type SetOptions struct {
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
Config func() (config.Config, error)
BaseRepo func() (ghrepo.Interface, error)
Prompter iprompter
VariableName string
OrgName string
EnvName string
Body string
Visibility string
RepositoryNames []string
EnvFile string
}
func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command {
opts := &SetOptions{
IO: f.IOStreams,
Config: f.Config,
HttpClient: f.HttpClient,
Prompter: f.Prompter,
}
cmd := &cobra.Command{
Use: "set <variable-name>",
Short: "Create or update variables",
Long: heredoc.Doc(`
Set a value for a variable on one of the following levels:
- repository (default): available to GitHub Actions runs or Dependabot in a repository
- environment: available to GitHub Actions runs for a deployment environment in a repository
- organization: available to GitHub Actions runs or Dependabot within an organization
Organization variable can optionally be restricted to only be available to
specific repositories.
`),
Example: heredoc.Doc(`
# Add variable value for the current repository in an interactive prompt
$ gh variable set MYVARIABLE
# Read variable value from an environment variable
$ gh variable set MYVARIABLE --body "$ENV_VALUE"
# Read variable value from a file
$ gh variable set MYVARIABLE < myfile.txt
# Set variable for a deployment environment in the current repository
$ gh variable set MYVARIABLE --env myenvironment
# Set organization-level variable visible to both public and private repositories
$ gh variable set MYVARIABLE --org myOrg --visibility all
# Set organization-level variable visible to specific repositories
$ gh variable set MYVARIABLE --org myOrg --repos repo1,repo2,repo3
# Set multiple variables imported from the ".env" file
$ gh variable set -f .env
`),
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
// support `-R, --repo` override
opts.BaseRepo = f.BaseRepo
if err := cmdutil.MutuallyExclusive("specify only one of `--org` or `--env`", opts.OrgName != "", opts.EnvName != ""); err != nil {
return err
}
if err := cmdutil.MutuallyExclusive("specify only one of `--body` or `--env-file`", opts.Body != "", opts.EnvFile != ""); err != nil {
return err
}
if len(args) == 0 {
if opts.EnvFile == "" {
return cmdutil.FlagErrorf("must pass name argument")
}
} else {
opts.VariableName = args[0]
}
if cmd.Flags().Changed("visibility") {
if opts.OrgName == "" {
return cmdutil.FlagErrorf("`--visibility` is only supported with `--org`")
}
if opts.Visibility != shared.Selected && len(opts.RepositoryNames) > 0 {
return cmdutil.FlagErrorf("`--repos` is only supported with `--visibility=selected`")
}
if opts.Visibility == shared.Selected && len(opts.RepositoryNames) == 0 {
return cmdutil.FlagErrorf("`--repos` list required with `--visibility=selected`")
}
} else {
if len(opts.RepositoryNames) > 0 {
opts.Visibility = shared.Selected
}
}
if runF != nil {
return runF(opts)
}
return setRun(opts)
},
}
cmd.Flags().StringVarP(&opts.OrgName, "org", "o", "", "Set `organization` variable")
cmd.Flags().StringVarP(&opts.EnvName, "env", "e", "", "Set deployment `environment` variable")
cmdutil.StringEnumFlag(cmd, &opts.Visibility, "visibility", "v", shared.Private, []string{shared.All, shared.Private, shared.Selected}, "Set visibility for an organization variable")
cmd.Flags().StringSliceVarP(&opts.RepositoryNames, "repos", "r", []string{}, "List of `repositories` that can access an organization variable")
cmd.Flags().StringVarP(&opts.Body, "body", "b", "", "The value for the variable (reads from standard input if not specified)")
cmd.Flags().StringVarP(&opts.EnvFile, "env-file", "f", "", "Load variable names and values from a dotenv-formatted `file`")
return cmd
}
func setRun(opts *SetOptions) error {
variables, err := getVariablesFromOptions(opts)
if err != nil {
return err
}
c, err := opts.HttpClient()
if err != nil {
return fmt.Errorf("could not set http client: %w", err)
}
client := api.NewClientFromHTTP(c)
orgName := opts.OrgName
envName := opts.EnvName
var host string
var baseRepo ghrepo.Interface
if orgName == "" {
baseRepo, err = opts.BaseRepo()
if err != nil {
return err
}
host = baseRepo.RepoHost()
} else {
cfg, err := opts.Config()
if err != nil {
return err
}
host, _ = cfg.Authentication().DefaultHost()
}
entity, err := shared.GetVariableEntity(orgName, envName)
if err != nil {
return err
}
opts.IO.StartProgressIndicator()
repositoryIDs, err := getRepoIds(client, host, opts.OrgName, opts.RepositoryNames)
opts.IO.StopProgressIndicator()
if err != nil {
return err
}
setc := make(chan setResult)
for key, value := range variables {
k := key
v := value
go func() {
setOpts := setOptions{
Entity: entity,
Environment: envName,
Key: k,
Organization: orgName,
Repository: baseRepo,
RepositoryIDs: repositoryIDs,
Value: v,
Visibility: opts.Visibility,
}
setc <- setVariable(client, host, setOpts)
}()
}
err = nil
cs := opts.IO.ColorScheme()
for i := 0; i < len(variables); i++ {
result := <-setc
if result.Err != nil {
err = multierror.Append(err, result.Err)
continue
}
if !opts.IO.IsStdoutTTY() {
continue
}
target := orgName
if orgName == "" {
target = ghrepo.FullName(baseRepo)
}
if envName != "" {
target += " environment " + envName
}
fmt.Fprintf(opts.IO.Out, "%s %s variable %s for %s\n", cs.SuccessIcon(), result.Operation, result.Key, target)
}
return err
}
func getVariablesFromOptions(opts *SetOptions) (map[string]string, error) {
variables := make(map[string]string)
if opts.EnvFile != "" {
var r io.Reader
if opts.EnvFile == "-" {
defer opts.IO.In.Close()
r = opts.IO.In
} else {
f, err := os.Open(opts.EnvFile)
if err != nil {
return nil, fmt.Errorf("failed to open env file: %w", err)
}
defer f.Close()
r = f
}
envs, err := godotenv.Parse(r)
if err != nil {
return nil, fmt.Errorf("error parsing env file: %w", err)
}
if len(envs) == 0 {
return nil, fmt.Errorf("no variables found in file")
}
for key, value := range envs {
variables[key] = value
}
return variables, nil
}
body, err := getBody(opts)
if err != nil {
return nil, fmt.Errorf("did not understand variable body: %w", err)
}
variables[opts.VariableName] = body
return variables, nil
}
func getBody(opts *SetOptions) (string, error) {
if opts.Body != "" {
return opts.Body, nil
}
if opts.IO.CanPrompt() {
bodyInput, err := opts.Prompter.Input("Paste your variable", "")
if err != nil {
return "", err
}
fmt.Fprintln(opts.IO.Out)
return bodyInput, nil
}
body, err := io.ReadAll(opts.IO.In)
if err != nil {
return "", fmt.Errorf("failed to read from standard input: %w", err)
}
return string(bytes.TrimRight(body, "\r\n")), nil
}
func getRepoIds(client *api.Client, host, owner string, repositoryNames []string) ([]int64, error) {
if len(repositoryNames) == 0 {
return nil, nil
}
repos := make([]ghrepo.Interface, 0, len(repositoryNames))
for _, repositoryName := range repositoryNames {
if repositoryName == "" {
continue
}
var repo ghrepo.Interface
if strings.Contains(repositoryName, "/") || owner == "" {
var err error
repo, err = ghrepo.FromFullNameWithHost(repositoryName, host)
if err != nil {
return nil, fmt.Errorf("invalid repository name")
}
} else {
repo = ghrepo.NewWithHost(owner, repositoryName, host)
}
repos = append(repos, repo)
}
if len(repos) == 0 {
return nil, fmt.Errorf("resetting repositories selected to zero is not supported")
}
repositoryIDs, err := api.GetRepoIDs(client, host, repos)
if err != nil {
return nil, fmt.Errorf("failed to look up IDs for repositories %v: %w", repositoryNames, err)
}
return repositoryIDs, nil
}
|