Documentation
¶
Overview ¶
Code generated by go generate; DO NOT EDIT.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateLogger ¶
func CreateLogger( stdoutTarget zapcore.WriteSyncer, stderrTarget zapcore.WriteSyncer, config *Config, ) (*zap.Logger, error)
CreateLogger creates a logger for tool logs (debug, info, error etc.) that writes to the provided stdout and stderr targets. This will determine the log level based on the provided configuration.
Types ¶
type Config ¶
type Config struct {
// The current version of the plugin docgen software.
// This will be set based on a value of a constant determined at build time.
Version string
// The current version of the plugin framework that is being used
// by the plugin docgen tool.
// This will be set based on a value of a constant determined at build time.
PluginFrameworkVersion string
// The current version of the blueprint framework that is being used
// by the plugin docgen tool.
// This will be set based on a value of a constant determined at build time.
BlueprintFrameworkVersion string
// The current version of the provider plugin protocol that is being used
// by the plugin docgen tool when acting as a plugin host.
// This will be set at runtime based on the version of the plugin protocol
// that the current version of the tool uses.
ProviderPluginProtocolVersion string
// The current version of the transformer plugin protocol that is being used
// by the plugin docgen tool when acting as a plugin host.
// This will be set at runtime based on the version of the plugin protocol
// that the current version of the tool uses.
TransformerPluginProtocolVersion string
PluginPath string `env:"CELERITY_DEPLOY_ENGINE_PLUGIN_PATH"`
PluginLogFileRootDir string `env:"CELERITY_PLUGIN_DOCGEN_PLUGIN_LOG_FILE_ROOT_DIR"`
LogLevel string `env:"CELERITY_PLUGIN_DOCGEN_LOG_LEVEL" envDefault:"info"`
LaunchWaitTimeoutMS int `env:"CELERITY_PLUGIN_DOCGEN_PLUGIN_LAUNCH_WAIT_TIMEOUT_MS" envDefault:"10000"`
GenerateTimeoutMS int `env:"CELERITY_PLUGIN_DOCGEN_GENERATE_TIMEOUT_MS" envDefault:"30000"`
}
Config holds the configuration for the github registry service.
func LoadConfig ¶
LoadConfig loads environment configuration for the plugin JSON doc generator tool.
Click to show internal directories.
Click to hide internal directories.