refactor(repo): Improve log format

Author: pedronauck

internal/config/config.go

@@ -24,9 +24,33 @@ type Config struct {
 
 var configFileCandidates = []string{".pr-release", ".compozy-release"}
 
-// DefaultConfig returns a Config with default values.
 func DefaultConfig() *Config {
-	return &Config{ToolsDir: "tools", LogLevel: "info", LogFormat: "json"}
+	logFormat := "json"
+	if isCI() {
+		logFormat = "console"
+	}
+	return &Config{ToolsDir: "tools", LogLevel: "info", LogFormat: logFormat}
+}
+
+func isCI() bool {
+	ciEnvVars := []string{
+		"CI",
+		"CONTINUOUS_INTEGRATION",
+		"GITHUB_ACTIONS",
+		"GITLAB_CI",
+		"CIRCLECI",
+		"TRAVIS",
+		"JENKINS_URL",
+		"BUILDKITE",
+		"DRONE",
+		"TEAMCITY_VERSION",
+	}
+	for _, envVar := range ciEnvVars {
+		if os.Getenv(envVar) != "" {
+			return true
+		}
+	}
+	return false
 }
 
 // Validate validates the configuration.
@@ -126,8 +150,6 @@ func LoadConfig() (*Config, error) {
 	v := viper.New()
 	v.SetConfigType("yaml")
 	v.AddConfigPath(".")
-	v.SetDefault("log_level", "info")
-	v.SetDefault("log_format", "json")
 	v.AutomaticEnv()
 	v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
 	if err := v.BindEnv(
@@ -179,6 +201,8 @@ func LoadConfig() (*Config, error) {
 	}
 	defaults := DefaultConfig()
 	v.SetDefault("tools_dir", defaults.ToolsDir)
+	v.SetDefault("log_level", defaults.LogLevel)
+	v.SetDefault("log_format", defaults.LogFormat)
 	for _, name := range configFileCandidates {
 		v.SetConfigName(name)
 		if err := v.ReadInConfig(); err != nil {

internal/logger/logger.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"strings"
 	"syscall"
 
@@ -18,6 +19,11 @@ type Config struct {
 
 type contextKey struct{}
 
+const (
+	formatJSON    = "json"
+	formatConsole = "console"
+)
+
 func New(cfg Config) (*zap.Logger, error) {
 	zapCfg, err := buildZapConfig(cfg)
 	if err != nil {
@@ -30,9 +36,9 @@ func buildZapConfig(cfg Config) (zap.Config, error) {
 	format := strings.ToLower(strings.TrimSpace(cfg.Format))
 	var zapCfg zap.Config
 	switch format {
-	case "json":
+	case formatJSON:
 		zapCfg = zap.NewProductionConfig()
-	case "console":
+	case formatConsole:
 		zapCfg = zap.NewDevelopmentConfig()
 	default:
 		return zap.Config{}, fmt.Errorf("logger: unsupported format %s", cfg.Format)
@@ -43,6 +49,14 @@ func buildZapConfig(cfg Config) (zap.Config, error) {
 	}
 	zapCfg.Level = zap.NewAtomicLevelAt(level)
 	zapCfg.Encoding = format
+	encoder := buildEncoderConfig(format)
+	zapCfg.EncoderConfig = encoder
+	zapCfg.OutputPaths = []string{"stdout"}
+	zapCfg.ErrorOutputPaths = []string{"stderr"}
+	return zapCfg, nil
+}
+
+func buildEncoderConfig(format string) zapcore.EncoderConfig {
 	encoder := zapcore.EncoderConfig{
 		TimeKey:        "ts",
 		LevelKey:       "level",
@@ -56,13 +70,36 @@ func buildZapConfig(cfg Config) (zap.Config, error) {
 		EncodeDuration: zapcore.SecondsDurationEncoder,
 		EncodeCaller:   zapcore.ShortCallerEncoder,
 	}
-	if format == "console" {
-		encoder.EncodeLevel = zapcore.CapitalColorLevelEncoder
+	if format == formatConsole {
+		if isCI() {
+			encoder.EncodeLevel = zapcore.CapitalLevelEncoder
+			encoder.EncodeTime = zapcore.RFC3339TimeEncoder
+		} else {
+			encoder.EncodeLevel = zapcore.CapitalColorLevelEncoder
+		}
 	}
-	zapCfg.EncoderConfig = encoder
-	zapCfg.OutputPaths = []string{"stdout"}
-	zapCfg.ErrorOutputPaths = []string{"stderr"}
-	return zapCfg, nil
+	return encoder
+}
+
+func isCI() bool {
+	ciEnvVars := []string{
+		"CI",
+		"CONTINUOUS_INTEGRATION",
+		"GITHUB_ACTIONS",
+		"GITLAB_CI",
+		"CIRCLECI",
+		"TRAVIS",
+		"JENKINS_URL",
+		"BUILDKITE",
+		"DRONE",
+		"TEAMCITY_VERSION",
+	}
+	for _, envVar := range ciEnvVars {
+		if os.Getenv(envVar) != "" {
+			return true
+		}
+	}
+	return false
 }
 
 func parseLevel(level string) (zapcore.Level, error) {