vault/tools/pipeline/internal/cmd/github.go
Ryan Cragun 2f4167ee9a
[VAULT-38027] pipeline(active-versions): add --github-output support (#31239)
The standard JSON output of `pipeline release list active-versions
--format json` returns the configuration in the same schema as
`.release/versions.hcl`. While that is intended for the command, the
schema itself is not easy to use with the built-in functions in Github
Actions which often requires complex JQ queries to reshape the data to
be useful. Instead, add a `--github-output` flag that will
automatically write the active versions to `$GITHUB_OUTPUT` encoded as
JSON but with multiple useful top-level keys that make utilizing it in
Github Actions a breeze. This support will be utilized in future pull
requests.

Signed-off-by: Ryan Cragun <me@ryan.ec>
2025-07-10 17:10:46 -06:00

71 lines
1.9 KiB
Go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1
package cmd
import (
"fmt"
"os"
"path/filepath"
"github.com/google/go-github/v68/github"
"github.com/hashicorp/vault/tools/pipeline/internal/pkg/git"
"github.com/spf13/cobra"
)
type githubCommandState struct {
Github *github.Client
Git *git.Client
}
var githubCmdState = &githubCommandState{
Github: github.NewClient(nil),
Git: git.NewClient(git.WithLoadTokenFromEnv()),
}
func newGithubCmd() *cobra.Command {
githubCmd := &cobra.Command{
Use: "github",
Short: "Github commands",
Long: "Github commands",
}
githubCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
if token, set := os.LookupEnv("GITHUB_TOKEN"); set {
githubCmdState.Github = githubCmdState.Github.WithAuthToken(token)
} else {
fmt.Println("\x1b[1;33;49mWARNING\x1b[0m: GITHUB_TOKEN has not been set. While not always required for read actions on public repositories you're likely to get throttled without it")
}
return nil
}
githubCmd.AddCommand(newGithubCopyCmd())
githubCmd.AddCommand(newGithubCreateCmd())
githubCmd.AddCommand(newGithubListCmd())
return githubCmd
}
func writeToGithubOutput(key string, bytes []byte) error {
devPath, ok := os.LookupEnv("GITHUB_OUTPUT")
if !ok {
return fmt.Errorf("$GITHUB_OUTPUT has not been set. Cannot write %s to it", key)
}
expanded, err := filepath.Abs(devPath)
if err != nil {
return fmt.Errorf("failed to expand $GITHUB_OUTPUT path: %w", err)
}
dev, err := os.OpenFile(expanded, os.O_APPEND|os.O_WRONLY, 0o644)
if err != nil {
return fmt.Errorf("failed to open $GITHUB_OUTPUT for writing: %w", err)
}
defer func() { _ = dev.Close() }()
_, err = dev.Write(append(append([]byte(key+"="), bytes...), []byte("\n")...))
if err != nil {
return fmt.Errorf("failed to write key %s to $GITHUB_OUTPUT: %w", key, err)
}
return nil
}