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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 5 commits into from May 2, 2024
Merged

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

merged 5 commits into from May 2, 2024

Conversation

zkoppert
Copy link
Member

@zkoppert zkoppert commented May 1, 2024 •
edited

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

@zkoppert
feat: Split markdown files when larger than max issue body size
a26168d 
Signed-off-by: Zack Koppert <zkoppert@github.com>
@zkoppert zkoppert requested a review from jmeridth as a code owner May 1, 2024 05:37
@zkoppert zkoppert mentioned this pull request May 1, 2024
Closed
@zkoppert
fix: formatting errors
c9c7a47 
Signed-off-by: Zack Koppert <zkoppert@github.com>
jmeridth
jmeridth approved these changes May 1, 2024
View reviewed changes
Copy link
Member

@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:

zkoppert
zkoppert commented May 2, 2024
View reviewed changes
docs/dealing-with-large-issue-metrics.md Outdated Show resolved Hide resolved
docs/dealing-with-large-issue-metrics.md Outdated Show resolved Hide resolved
test_markdown_helpers.py Outdated Show resolved Hide resolved
@zkoppert zkoppert merged commit ed65b33 into main May 2, 2024
27 checks passed
@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
Reviewers

@jmeridth jmeridth jmeridth approved these changes

Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Prevent a big report to fail creating the issue
2 participants
@zkoppert @jmeridth