Skip to content

Conversation

@lineargraph
Copy link

image
Adds the reuse tool output as markdown to the summary page of the action

Copy link
Member

@mxmehl mxmehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution.

With a simple usage of the action, this works well, but if you look at the summary of the checks against this pull request, you see that e.g. running the action multiple times or with flags like --json may create odd results: https://github.com/fsfe/reuse-action/actions/runs/5870075466

Therefore, my suggestion would be to make the summary configurable, enabled by default. I'm not sure what's the best way to implement that. Perhaps environment variables? I wouldn't choose args as these should be the available arguments to reuse.

@lineargraph lineargraph force-pushed the main-1 branch 5 times, most recently from b4f62ca to 0560044 Compare August 16, 2023 10:48
@lineargraph lineargraph requested a review from mxmehl August 16, 2023 10:59
@lineargraph
Copy link
Author

I implemented the option to disable/change the output using a with: argument. This also enabled prettily formatted json output (although that one tends to get verbose quickly).

@mxmehl
Copy link
Member

mxmehl commented Aug 16, 2023

I implemented the option to disable/change the output using a with: argument. This also enabled prettily formatted json output (although that one tends to get verbose quickly).

Thank you! Looks good on first sight but I would like to test and understand a bit more in detail. Not sure whether I can manage this before my vacation, but it's on my todo list.

@GooRoo
Copy link

GooRoo commented Aug 7, 2024

Hey guys, what's with this PR? Is it going to be merged?

inputs:
summary:
description: "Show your REUSE compliance report in the github step summary using markdown (`markdown`), a json codeblock (`json`) or not at all (`none`)"
required: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's a default. why is it mandatory?

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

Successfully merging this pull request may close these issues.

4 participants