Skip to content

feat: Split markdown files when larger than max issue body size#265

Merged
zkoppert merged 5 commits intomainfrom
big-reports
May 2, 2024
Merged

feat: Split markdown files when larger than max issue body size#265
zkoppert merged 5 commits intomainfrom
big-reports

Conversation

@zkoppert
Copy link
Copy Markdown
Collaborator

@zkoppert zkoppert commented May 1, 2024

Pull Request

fixes #258

Proposed Changes

This pull request introduces changes to handle large issue_metrics.md files that exceed GitHub's maximum issue body character limit. The changes include splitting large markdown files into smaller ones, adding new helper functions to handle these operations, and updating the README.md with a link to a new document explaining how to deal with large markdown files.

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

Reviewer

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

Signed-off-by: Zack Koppert <zkoppert@github.com>
Signed-off-by: Zack Koppert <zkoppert@github.com>
Copy link
Copy Markdown
Collaborator

@jmeridth jmeridth left a comment

Choose a reason for hiding this comment

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

🎉 :shipit:

Comment thread docs/dealing-with-large-issue-metrics.md Outdated
Comment thread docs/dealing-with-large-issue-metrics.md Outdated
Comment thread test_markdown_helpers.py Outdated
@zkoppert zkoppert merged commit ed65b33 into main May 2, 2024
@zkoppert zkoppert deleted the big-reports branch May 2, 2024 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Prevent a big report to fail creating the issue

2 participants