Skip to content

breaking output limited to one line #42

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

Closed
ssukienn opened this issue Feb 26, 2024 · 4 comments
Closed

breaking output limited to one line #42

ssukienn opened this issue Feb 26, 2024 · 4 comments

Comments

@ssukienn
Copy link

I've seen #35 but still, what is the purpose of that head?

Breaking output is different than diff or changelog. I would like to use that output in the PR comment. Could this be changed?

@effoeffi
Copy link
Contributor

The idea is to include a summary in the PR and provide links to the report, as well as to the diff and changelog. The report can contain hundreds of lines. We initiated a discussion about this here. Please feel free to add your feedback.

@ssukienn
Copy link
Author

Thanks for the input.

What's wrong with output having hundreds of lines? If I made that many breaking changes I would like to inspect those and text format in one place might be more convieniet at times (than annotations). And I've seen you already scoping it for that 1mb gh limit in all cases.

Currently diff and changelog have no limits but breaking has it out of the blue, for the same GITHUB_OUTPUT.

My use case is to present the breaking change inspection in the spoiler format in the GitHub comment. Annotations are nice but my use case is to present text format in a comment. This is similar to Spacelift integration commenting its terraform plans on PR.

I understand you want to revamp and enchance how action would work in general though this is the problem I'm facing on the current action version.

@effoeffi
Copy link
Contributor

effoeffi commented Mar 1, 2024

Thank you for the feedback.
I believe it would enhance readability to include a summary of the breaking changes, changelog, or diff alongside a link to a detailed report, instead of generating a comment on the PR summary for each build that includes hundreds or thousands of lines.
We considered outputting raw data that users would need to decode, but the only scenario where displaying the output as part of the PR seemed appropriate.

@effoeffi
Copy link
Contributor

effoeffi commented Mar 6, 2024

@ssukienn could you please take a look at this PR and let me know if it resolves your issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants