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

Combining multiple reports into a single GitHub issue #156

Open
2 tasks done
spier opened this issue Oct 25, 2023 · 5 comments
Open
2 tasks done

Combining multiple reports into a single GitHub issue #156

spier opened this issue Oct 25, 2023 · 5 comments
Labels
enhancement New feature or request keep

Comments

@spier
Copy link
Contributor

spier commented Oct 25, 2023

In InnerSourceCommons/InnerSourcePatterns#599 I learned that it is possible already to merge multiple reports into a single reports by apply a smart concatenation of multiple GHA steps. Very cool!

Here an example of how the resulting combined report looks like:
InnerSourceCommons/InnerSourcePatterns#601

I had some possible improvement ideas, related to this "combined reports" scenario:

Custom report title

The top-level title in the GitHub issue is always "Issue Metrics" right now. That is not really an issue if the GitHub issue only contains a single report, as the title of the GitHub issue itself can be used to provide a customized description of what the report is about.

However when a single GitHub issue contains multiple reports, this becomes more tricky.

Therefore we could add a configuration value REPORT_TITLE, roughly like this:

field required default description
REPORT_TITLE false "Issue Metrics" A custom title that will be printed at the very top of the report. Note: Most useful when combining multiple reports into a single issue.

Custom output file

The issue_metrics GHA always writes to the file issue_metrics.md.

When combining multiple reports into a single issue it would be helpful to write to different filenames, so that those files can then be concatenated into a single file, which is then written to a GitHub issue.

field required default description
OUTPUT_FILE false issue_metrics.md A custom output file that the report will be written to. Note: Most useful when combining multiple reports into a single issue.

Always print the title and the search query

As shown in InnerSourceCommons/InnerSourcePatterns#601, an empty report will only say "no issues found for the given search criteria".

It would be helpful to always print the title, as well as the search query that was used.

That helps will debugging and identifying what the specific report was meant to be about.

Tasks

  1. enhancement
@spier
Copy link
Contributor Author

spier commented Oct 25, 2023

@zkoppert looking forward to your feedback on this.

If you were considering to integrate a multi-report feature into the core functionality of issue-metrics itself, then some of the ideas above wouldn't be that useful any more.

@zkoppert
Copy link
Member

zkoppert commented Oct 25, 2023

Yeah, these are great ideas!! I think that these are ready to implement as you described them here. I'll start by tackling the last one of always printing the title and search query: #157

@spier
Copy link
Contributor Author

spier commented Oct 26, 2023

Awesome!

I will also try myself on one of the other ones. They sound like they shouldn't be too hard to implement but of course the devil is in the detail :) I think I will need with creating tests, as I wasn't clear from a first read of the repo what the testing approach is. So likely I will push the functionality with a minimal test, and then ask for review and help with further tests.

@zkoppert zkoppert added the enhancement New feature or request label Jan 9, 2024
Copy link

This issue is stale because it has been open 21 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the Stale label Mar 13, 2024
@zkoppert zkoppert added keep and removed Stale labels Mar 14, 2024
@Piedone
Copy link

Piedone commented Jun 2, 2024

FYI here's an example of how we combine reports for Orchard Core. As you can see, not too complex, we just concat files in PowerShell.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request keep
Projects
None yet
Development

No branches or pull requests

3 participants