From e3dca62837dae7362b6ac678c62a1f0807e1cf50 Mon Sep 17 00:00:00 2001 From: DiptoChakrabarty Date: Sat, 11 Jun 2022 18:46:15 +0530 Subject: [PATCH 1/2] replace pk/errors dependency release notes package --- cmd/release-notes/main.go | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/cmd/release-notes/main.go b/cmd/release-notes/main.go index 80465b7af98..e82b23a3f89 100644 --- a/cmd/release-notes/main.go +++ b/cmd/release-notes/main.go @@ -24,7 +24,6 @@ import ( "path/filepath" "strings" - "github.com/pkg/errors" "github.com/sirupsen/logrus" "github.com/spf13/cobra" @@ -284,12 +283,12 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { if releaseNotesOpts.outputFile != "" { output, err = os.OpenFile(releaseNotesOpts.outputFile, os.O_RDWR|os.O_CREATE, os.FileMode(0o644)) if err != nil { - return errors.Wrapf(err, "opening the supplied output file") + return fmt.Errorf("opening the supplied output file: %w", err) } } else { output, err = os.CreateTemp("", "release-notes-") if err != nil { - return errors.Wrapf(err, "creating a temporary file to write the release notes to") + return fmt.Errorf("creating a temporary file to write the release notes to: %w", err) } } @@ -302,7 +301,7 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { if len(byteValue) > 0 { if err := json.Unmarshal(byteValue, &existingNotes); err != nil { - return errors.Wrapf(err, "unmarshalling existing notes") + return fmt.Errorf("unmarshalling existing notes: %w", err) } } @@ -325,17 +324,17 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { enc := json.NewEncoder(output) enc.SetIndent("", " ") if err := enc.Encode(releaseNotes.ByPR()); err != nil { - return errors.Wrapf(err, "encoding JSON output") + return fmt.Errorf(err, "encoding JSON output: %w", err) } } else { doc, err := document.New(releaseNotes, opts.StartRev, opts.EndRev) if err != nil { - return errors.Wrapf(err, "creating release note document") + return fmt.Errorf(err, "creating release note document: %w", err) } markdown, err := doc.RenderMarkdownTemplate(opts.ReleaseBucket, opts.ReleaseTars, "", opts.GoTemplate) if err != nil { - return errors.Wrapf(err, "rendering release note document with template") + return fmt.Errorf("rendering release note document with template: %w", err) } const nl = "\n" @@ -348,7 +347,7 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { url, opts.StartSHA, opts.EndSHA, ) if err != nil { - return errors.Wrap(err, "generating dependency report") + return fmt.Errorf(err, "generating dependency report") } markdown += strings.Repeat(nl, 2) + deps } From a377af1f65e3460d1328bd1a0b81ee60059df1ad Mon Sep 17 00:00:00 2001 From: DiptoChakrabarty Date: Sat, 11 Jun 2022 19:00:17 +0530 Subject: [PATCH 2/2] fix errors --- cmd/release-notes/main.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/cmd/release-notes/main.go b/cmd/release-notes/main.go index e82b23a3f89..51f7470f1cc 100644 --- a/cmd/release-notes/main.go +++ b/cmd/release-notes/main.go @@ -324,12 +324,12 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { enc := json.NewEncoder(output) enc.SetIndent("", " ") if err := enc.Encode(releaseNotes.ByPR()); err != nil { - return fmt.Errorf(err, "encoding JSON output: %w", err) + return fmt.Errorf("encoding JSON output: %w", err) } } else { doc, err := document.New(releaseNotes, opts.StartRev, opts.EndRev) if err != nil { - return fmt.Errorf(err, "creating release note document: %w", err) + return fmt.Errorf("creating release note document: %w", err) } markdown, err := doc.RenderMarkdownTemplate(opts.ReleaseBucket, opts.ReleaseTars, "", opts.GoTemplate) @@ -347,7 +347,7 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { url, opts.StartSHA, opts.EndSHA, ) if err != nil { - return fmt.Errorf(err, "generating dependency report") + return fmt.Errorf("generating dependency report: %w", err) } markdown += strings.Repeat(nl, 2) + deps } @@ -360,13 +360,13 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { MaxDepth: mdtoc.MaxHeaderDepth, }) if err != nil { - return errors.Wrap(err, "generating table of contents") + return fmt.Errorf("generating table of contents: %w", err) } markdown = toc + nl + markdown } if _, err := output.WriteString(markdown); err != nil { - return errors.Wrap(err, "writing output file") + return fmt.Errorf("writing output file: %w", err) } } @@ -377,7 +377,7 @@ func WriteReleaseNotes(releaseNotes *notes.ReleaseNotes) (err error) { func run(*cobra.Command, []string) error { releaseNotes, err := notes.GatherReleaseNotes(opts) if err != nil { - return errors.Wrapf(err, "gathering release notes") + return fmt.Errorf("gathering release notes: %w", err) } return WriteReleaseNotes(releaseNotes)