Output customizations: REPORT_TITLE and OUTPUT_FILE

[spier]

Proposed Changes

Contributes to #156.

My plan is to implement customizability for both REPORT_TITLE and OUTPUT_FILE in this PR.

Status:

• REPORT_TITLE - First working implementation of a customizable REPORT_TITLE
• OUTPUT_FILE - Not implemented yet

I am sharing this PR early, to get feedback about preferred implementation and testability

Readiness Checklist

Author/Contributor

• [ ] If documentation is needed for this change, has that been included in this pull request
• [x] run make lint and fix any issues that you have introduced
• [x] run make test and ensure you have test coverage for the lines you are introducing

Reviewer

• [ ] Label as either bug, documentation, enhancement, infrastructure, or breaking

[spier]

@zkoppert I am adding some questions in inline comments, where I wasn't sure how to best implement things.

[spier]

@zkoppert just had a somewhat random idea:

What if we would implement the same functionality but with fewer ENV variables?

Idea

We could make the GHA append to issue_metrics.md, rather than to create a new file each time. Then the users could run the report generation steps in the order, in which we want the reports to appear in the final GitHub issue.

That way we would not have to introduce any new ENV variables.

However, this would likely be a breaking change, for anybody that is already creating combined reports today.

Alternative

OR, we add only a single variable COMBINE_REPORTS = True, which when set will do the appending as described above. This way we might not create a breaking change, if the default for COMBINE_REPORTS was False?

Not 100% clear about the pros/cons but figured I just share it for input :)

[zkoppert]

@zkoppert just had a somewhat random idea:

What if we would implement the same functionality but with fewer ENV variables?

Idea

We could make the GHA append to issue_metrics.md, rather than to create a new file each time. Then the users could run the report generation steps in the order, in which we want the reports to appear in the final GitHub issue.

That way we would not have to introduce any new ENV variables.

However, this would likely be a breaking change, for anybody that is already creating combined reports today.

Alternative

OR, we add only a single variable COMBINE_REPORTS = True, which when set will do the appending as described above. This way we might not create a breaking change, if the default for COMBINE_REPORTS was False?

Not 100% clear about the pros/cons but figured I just share it for input :)

Because the alternative is a breaking change, I prefer the route of COMBINE_REPORTS = True.

[jmeridth]

This has been open for a while. Completing in #373 and adding @spier and @zkoppert as co-authors. Once that merges, this will close. There are a few notes in the thread above that may turn into new issues (i.e., COMBINED_REPORTS = True).