Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: improve log messages #24

Merged
merged 1 commit into from
Feb 19, 2025
Merged

feat: improve log messages #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 36 additions & 14 deletions internal/module_builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,42 +39,54 @@ func (m *Module) Build() error {
}(logFile)

log := zerolog.New(logFile).With().Timestamp().Logger()
log.Info().Msg("building module")
log.Info().Msg("Building module")

if err := m.Prepare(&log); err != nil {
log.Error().Err(err).Msg("failed to prepare build")
log.Error().Err(err).Msg("Failed to prepare build")
return m.Rollback(&log)
}

log.Info().Msg("Prepare complete")

if err := m.Collect(&log); err != nil {
log.Error().Err(err).Msg("failed to collect build")
log.Error().Err(err).Msg("Failed to collect build")
return m.Rollback(&log)
}

log.Info().Msg("Build complete")

if err := m.Cleanup(&log); err != nil {
log.Error().Err(err).Msg("failed to cleanup build")
log.Error().Err(err).Msg("Failed to cleanup build")
return err
}

log.Info().Msg("Cleanup complete")

if err := m.Push(&log); err != nil {
log.Error().Err(err).Msg("failed to push build")
log.Error().Err(err).Msg("Failed to push build")
return err
}

log.Info().Msg("Push complete")

return nil
}

func (m *Module) Prepare(log *zerolog.Logger) error {
if err := m.IsValid(); err != nil {
log.Error().Err(err).Msg("prepare: module is invalid")
log.Error().Err(err).Msg("Prepare: module is invalid")
return err
}

log.Info().Msg("Validation complete")

if err := CheckStages(m); err != nil {
log.Error().Err(err).Msg("prepare: check stages failed")
log.Error().Err(err).Msg("Prepare: check stages failed")
return err
}

log.Info().Msg("Check stages complete")

if m.BuildDirectory == "" {
m.BuildDirectory = "./build"
}
Expand All @@ -85,26 +97,32 @@ func (m *Module) Prepare(log *zerolog.Logger) error {

path, err := mkdir(m.BuildDirectory)
if err != nil {
log.Error().Err(err).Msg("prepare: failed to make build directory")
log.Error().Err(err).Msg("Prepare: failed to make build directory")
return err
}

log.Info().Msgf("Build directory complete: %s", path)

m.BuildDirectory = path

path, err = mkdir(m.LogDirectory)
if err != nil {
log.Error().Err(err).Msg("prepare: failed to make log directory")
log.Error().Err(err).Msg("Prepare: failed to make log directory")
return err
}

log.Info().Msgf("Log directory complete: %s", path)

m.LogDirectory = path

_, err = mkdir(fmt.Sprintf("%s/%s", m.BuildDirectory, m.Version))
path, err = mkdir(fmt.Sprintf("%s/%s", m.BuildDirectory, m.Version))
if err != nil {
log.Error().Err(err).Msg("prepare: failed to make build version directory")
log.Error().Err(err).Msg("Prepare: failed to make build version directory")
return err
}

log.Info().Msgf("Build version directory complete: %s", path)

return nil
}

Expand All @@ -126,7 +144,7 @@ func (m *Module) Push(log *zerolog.Logger) error {
func (m *Module) Collect(log *zerolog.Logger) error {
buildDirectory, err := filepath.Abs(fmt.Sprintf("%s/%s", m.BuildDirectory, m.Version))
if err != nil {
log.Error().Err(err).Msg("failed to make build directory")
log.Error().Err(err).Msg("Failed to make build directory")
return err
}

Expand All @@ -153,16 +171,20 @@ func (m *Module) Collect(log *zerolog.Logger) error {
}

if len(errs) > 0 {
log.Error().Int("errors", len(errs)).Msg("failed to collect build")
log.Error().Int("errors", len(errs)).Msg("Failed to collect build")
return fmt.Errorf("errors: %v", errs)
}

log.Info().Msg("Collect complete")

zipPath := filepath.Join(m.BuildDirectory, fmt.Sprintf("%s.zip", m.Version))
if err := zipIt(buildDirectory, zipPath); err != nil {
log.Error().Err(err).Msg("failed to zip build")
log.Error().Err(err).Msg("Failed to zip build")
return err
}

log.Info().Msg("Zip complete")

return nil
}

Expand Down