Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Env ¶ added in v0.3.1
type Env struct {
// GitHubBaseURL is a base URL for GtiHub API requests.
// Defaults to the public GitHub API.
GitHubBaseURL string `envconfig:"GITHUB_BASE_URL" default:"https://api.github.com/"`
// GitHubToken is a personal access token for GitHub.
// This allows access to a private repository.
GitHubToken string `envconfig:"GITHUB_TOKEN"`
// GitLabBaseURL is a base URL for GitLab API requests.
// Defaults to the public GitLab API.
GitLabBaseURL string `envconfig:"GITLAB_BASE_URL" default:"https://gitlab.com/api/v4/"`
// GitLabToken is a personal access token for GitLab.
// This is needed for public and private projects on all instances.
GitLabToken string `envconfig:"GITLAB_TOKEN"`
// TFRegistryBaseURL is a base URL for Terraform registry.
// Defaults to the public Terraform registry.
// To use the public OpenTofu registry, set this to `https://registry.opentofu.org/`.
TFRegistryBaseURL string `envconfig:"TFREGISTRY_BASE_URL" default:"https://registry.terraform.io/"`
}
Env is a set of configurations read from environment variables.
type LockCommand ¶ added in v0.7.0
type LockCommand struct {
Meta
// contains filtered or unexported fields
}
LockCommand is a command which update dependency lock files.
func (*LockCommand) Help ¶ added in v0.7.0
func (c *LockCommand) Help() string
Help returns long-form help text.
func (*LockCommand) Run ¶ added in v0.7.0
func (c *LockCommand) Run(args []string) int
Run runs the procedure of this command.
func (*LockCommand) Synopsis ¶ added in v0.7.0
func (c *LockCommand) Synopsis() string
Synopsis returns one-line help text.
type Meta ¶
type Meta struct {
// UI is a user interface representing input and output.
UI cli.Ui
// Fs is an afero filesystem.
Fs afero.Fs
}
Meta are the meta-options that are available on all or most commands.
type ModuleCommand ¶ added in v0.3.0
type ModuleCommand struct {
Meta
// contains filtered or unexported fields
}
ModuleCommand is a command which update version constraints for module.
func (*ModuleCommand) Help ¶ added in v0.3.0
func (c *ModuleCommand) Help() string
Help returns long-form help text.
func (*ModuleCommand) Run ¶ added in v0.3.0
func (c *ModuleCommand) Run(args []string) int
Run runs the procedure of this command.
func (*ModuleCommand) Synopsis ¶ added in v0.3.0
func (c *ModuleCommand) Synopsis() string
Synopsis returns one-line help text.
type OpenTofuCommand ¶ added in v0.9.0
type OpenTofuCommand struct {
Meta
// contains filtered or unexported fields
}
OpenTofuCommand is a command which update version constraints for OpenTofu.
func (*OpenTofuCommand) Help ¶ added in v0.9.0
func (c *OpenTofuCommand) Help() string
Help returns long-form help text.
func (*OpenTofuCommand) Run ¶ added in v0.9.0
func (c *OpenTofuCommand) Run(args []string) int
Run runs the procedure of this command.
func (*OpenTofuCommand) Synopsis ¶ added in v0.9.0
func (c *OpenTofuCommand) Synopsis() string
Synopsis returns one-line help text.
type ProviderCommand ¶
type ProviderCommand struct {
Meta
// contains filtered or unexported fields
}
ProviderCommand is a command which update version constraints for provider.
func (*ProviderCommand) Help ¶
func (c *ProviderCommand) Help() string
Help returns long-form help text.
func (*ProviderCommand) Run ¶
func (c *ProviderCommand) Run(args []string) int
Run runs the procedure of this command.
func (*ProviderCommand) Synopsis ¶
func (c *ProviderCommand) Synopsis() string
Synopsis returns one-line help text.
type ReleaseCommand ¶
type ReleaseCommand struct {
Meta
}
ReleaseCommand is a command which just shows help for subcommands.
func (*ReleaseCommand) Help ¶
func (c *ReleaseCommand) Help() string
Help returns long-form help text.
func (*ReleaseCommand) Run ¶
func (c *ReleaseCommand) Run(args []string) int
Run runs the procedure of this command.
func (*ReleaseCommand) Synopsis ¶
func (c *ReleaseCommand) Synopsis() string
Synopsis returns one-line help text.
type ReleaseLatestCommand ¶
type ReleaseLatestCommand struct {
Meta
// contains filtered or unexported fields
}
ReleaseLatestCommand is a command which gets the latest release version.
func (*ReleaseLatestCommand) Help ¶
func (c *ReleaseLatestCommand) Help() string
Help returns long-form help text.
func (*ReleaseLatestCommand) Run ¶
func (c *ReleaseLatestCommand) Run(args []string) int
Run runs the procedure of this command.
func (*ReleaseLatestCommand) Synopsis ¶
func (c *ReleaseLatestCommand) Synopsis() string
Synopsis returns one-line help text.
type ReleaseListCommand ¶ added in v0.3.5
type ReleaseListCommand struct {
Meta
// contains filtered or unexported fields
}
ReleaseListCommand is a command which gets a list of release versions.
func (*ReleaseListCommand) Help ¶ added in v0.3.5
func (c *ReleaseListCommand) Help() string
Help returns long-form help text.
func (*ReleaseListCommand) Run ¶ added in v0.3.5
func (c *ReleaseListCommand) Run(args []string) int
Run runs the procedure of this command.
func (*ReleaseListCommand) Synopsis ¶ added in v0.3.5
func (c *ReleaseListCommand) Synopsis() string
Synopsis returns one-line help text.
type TerraformCommand ¶
type TerraformCommand struct {
Meta
// contains filtered or unexported fields
}
TerraformCommand is a command which update version constraints for terraform.
func (*TerraformCommand) Help ¶
func (c *TerraformCommand) Help() string
Help returns long-form help text.
func (*TerraformCommand) Run ¶
func (c *TerraformCommand) Run(args []string) int
Run runs the procedure of this command.
func (*TerraformCommand) Synopsis ¶
func (c *TerraformCommand) Synopsis() string
Synopsis returns one-line help text.