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

fix: pass through report name, issue title, and search query when report is empty #405

Merged
merged 4 commits into from
Oct 16, 2024

Conversation

zkoppert
Copy link
Member

@zkoppert zkoppert commented Oct 16, 2024

Pull Request

Proposed Changes

Main goal: Ensure that report name, issue title, and search query the pass through properly when the search query results are empty.
Minor addition: I also improved the readability of the write_to_markdown function calls by using named parameters instead of positional parameters.

Example of markdown report before and after this code change:

Before:

# 

no issues found for the given search criteria


_This report was generated with the [Issue Metrics Action](https://github.com/github/issue-metrics)_

After:

# Issue Metrics

no issues found for the given search criteria


_This report was generated with the [Issue Metrics Action](https://github.com/github/issue-metrics)_
Search query used to find these items: `repo:github/issue-metrics is:issue created:2024-10-01..2024-10-14`

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as either fix, documentation, enhancement, infrastructure, maintenance, or breaking

@github-actions github-actions bot added the fix label Oct 16, 2024
@zkoppert zkoppert marked this pull request as ready for review October 16, 2024 04:25
@zkoppert zkoppert self-assigned this Oct 16, 2024
@jmeridth
Copy link
Member

jmeridth commented Oct 16, 2024

Feedback but not blocking:

  • Can we update this with the new parameters or remove it? It still has the old 8 instead of the new ones.
  • No tests changes?

@zkoppert
Copy link
Member Author

Looking at testing now

jmeridth
jmeridth previously approved these changes Oct 16, 2024
@jmeridth jmeridth dismissed their stale review October 16, 2024 21:11

@zkoppert still working on it.

@zkoppert
Copy link
Member Author

No test updates as we don't test the main function for this app. Nothing inside the markdown writer changed so I wouldn't update those.

@zkoppert zkoppert merged commit c6f90db into main Oct 16, 2024
31 checks passed
@zkoppert zkoppert deleted the fix-no-result-report-formatting branch October 16, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants