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.

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

replace github.com/pkg/errors dependency in release notes package #2555

Merged
merged 2 commits into from
Jun 13, 2022
Merged
Changes from all commits
Commits
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
21 changes: 10 additions & 11 deletions cmd/release-notes/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (
"path/filepath"
"strings"

"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"

Expand Down Expand Up @@ -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)
}
}

Expand All @@ -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)
}
}

Expand All @@ -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("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("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"
Expand All @@ -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("generating dependency report: %w", err)
}
markdown += strings.Repeat(nl, 2) + deps
}
Expand All @@ -361,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)
}
}

Expand All @@ -378,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)
Expand Down