Documentation
¶
Index ¶
- Constants
- Variables
- func CheckForUpdate() <-chan string
- func ConfigDir() (string, error)
- func Rel(basepath, targpath string) string
- func ShowJSON(out *os.File, title string, res gjson.Result, format string, transform string) error
- func ShowJSONIterator[T any](stdout *os.File, title string, iter jsonview.Iterator[T], format string, ...) error
- type AuthConfig
- type BodyContentType
- type FileEmbedStyle
- type GenerateSpecParams
- type GitHubRelease
- type HasRawJSON
- type TargetInfo
Constants ¶
const Version = "0.1.0-alpha.72" // x-release-please-version
Variables ¶
var (
Command *cli.Command
)
var OutputFormats = []string{"auto", "explore", "json", "jsonl", "pretty", "raw", "yaml"}
Functions ¶
func CheckForUpdate ¶
func CheckForUpdate() <-chan string
CheckForUpdate starts a background check for new versions and returns a channel that will contain an update message if one is available
func Rel ¶
Rel returns a relative path similar to filepath.Rel but with custom behavior: - If target is empty, returns empty string - If relative path doesn't start with "../", it prefixes with "./"
Types ¶
type AuthConfig ¶
type AuthConfig struct {
AccessToken string `json:"access_token"`
RefreshToken string `json:"refresh_token,omitempty"`
TokenType string `json:"token_type"`
ConfigPath string `json:"-"`
}
AuthConfig stores the OAuth credentials
func NewAuthConfig ¶
func NewAuthConfig() (*AuthConfig, error)
NewAuthConfig creates a new AuthConfig with ConfigPath populated. Use this when creating a new config that you plan to save. For loading existing configs, use &AuthConfig{} and call Find() or Load().
func (*AuthConfig) Exists ¶
func (config *AuthConfig) Exists() bool
Exists checks if the auth config file exists
func (*AuthConfig) Find ¶
func (config *AuthConfig) Find() (bool, error)
Find searches for and loads the auth config from the standard location. Returns (true, nil) if config file exists and was successfully loaded. Returns (false, nil) if config file doesn't exist or is empty (not an error). Returns (false, error) if config file exists but failed to load due to an error.
func (*AuthConfig) Load ¶
func (config *AuthConfig) Load(configPath string) error
Load loads the auth config from a specific path. Returns nil if the file doesn't exist (not treated as an error). Returns nil if the file exists but is empty (not treated as an error). Returns error only if the file exists but fails to parse or read. Only sets ConfigPath if a valid config with AccessToken is successfully loaded.
func (*AuthConfig) Remove ¶
func (config *AuthConfig) Remove() error
Remove removes the auth config file
type BodyContentType ¶
type BodyContentType int
const ( EmptyBody BodyContentType = iota MultipartFormEncoded ApplicationJSON ApplicationOctetStream )
type FileEmbedStyle ¶
type FileEmbedStyle int
const ( EmbedText FileEmbedStyle = iota EmbedIOReader )
type GenerateSpecParams ¶
type GitHubRelease ¶
type GitHubRelease struct {
TagName string `json:"tag_name"`
}
type HasRawJSON ¶
type HasRawJSON interface {
RawJSON() string
}
Source Files