Skip to content

x/exp/cmd/gorelease: decide on report and diagnostic format #46372

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

Jump to bottom
Closed
Tracked by #46371
jayconrod opened this issue May 25, 2021 · 2 comments
Closed
Tracked by #46371

x/exp/cmd/gorelease: decide on report and diagnostic format #46372

jayconrod opened this issue May 25, 2021 · 2 comments
Labels
FrozenDueToAge modules NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
gorelease

Comments

@jayconrod
Copy link
Contributor

gorelease's output format is a bit messy. It's mostly inherited from apidiff without much additional thought.

Now that we have a more complete set of diagnostics, we should think about exactly what the output should look like.

I don't have a specific proposal yet; this issue is mostly a placeholder.

cc @jadekler
@jayconrod jayconrod added NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. modules Tools This label describes issues relating to any tools in the x/tools repository. labels May 25, 2021
@jayconrod jayconrod added this to the gorelease milestone May 25, 2021
@jayconrod jayconrod mentioned this issue May 25, 2021
Open
8 tasks
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/332375 mentions this issue: cmd/gorelease: change report output format

@gopherbot
Copy link
Contributor

Change https://golang.org/cl/333370 mentions this issue: cmd/gorelease: remove empty summaries for comparisons

gopherbot pushed a commit to golang/exp that referenced this issue Jul 8, 2021
cmd/gorelease: remove empty summaries for comparisons
8d2525e 
gorelease should not print an empty "# summary" section. Previously,
this happened when comparing modules with different paths. In this
case, the user probably just wants to compare APIs, and gorelease
shouldn't make a judgement about whether versions are valid.

For golang/go#46372

Change-Id: I1bbd032c943ba9f14c1a001fd3112d7c6eb3a635
Reviewed-on: https://go-review.googlesource.com/c/exp/+/333370
Trust: Jay Conrod <jayconrod@google.com>
Trust: Jean de Klerk <deklerk@google.com>
Run-TryBot: Jay Conrod <jayconrod@google.com>
Reviewed-by: Jean de Klerk <deklerk@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
@golang golang locked and limited conversation to collaborators Jul 8, 2022
misak113 pushed a commit to misak113/exp that referenced this issue Mar 14, 2025
@misak113
cmd/gorelease: change report output format
2e1eb73 
This CL changes gorelease's output to be similar to 'go vet'.

* Messages for a specific packages are preceded by a heading like
  '# example.com/pkg'.
* Messages about compatible and incompatible changes appear under
  '## compatible changes' and '## incompatible changes' headings.
* Diagnostics are preceded by a '# diagnostics' heading.
* Other messages are printed at the bottom below '# summary'.
* Sections are separated by blank lines.

Tests were updated with 'go test -u'. No other test changes made.

Fixes golang/go#46372

Change-Id: I95062096c9470a05083cff8d728072b10dd04474
Reviewed-on: https://go-review.googlesource.com/c/exp/+/332375
Trust: Jay Conrod <jayconrod@google.com>
Trust: Jean de Klerk <deklerk@google.com>
Run-TryBot: Jay Conrod <jayconrod@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Jean de Klerk <deklerk@google.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge modules NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
gorelease
Development

No branches or pull requests
2 participants
@jayconrod @gopherbot