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: Revise length of generated GitHub issue link to avoid hitting URI max length #1336

Open
wants to merge 2 commits into
base: development
Choose a base branch
from

Conversation

stalgiag
Copy link
Contributor

This PR truncates conflict markdown when a "Raise an issue" link has more than 8k chars.

Assumptions:

  • 8k was tested in Chrome, Firefox, and Safari. It works on all. There is conflicting information about the limits for Edge but the most up-to-date info suggests that it shares Chrome's limit which would make sense.
  • I couldn't create a testing scenario in which anything other than conflict markdown creates an issue link that exceeds this limit. If a reviewer believes otherwise please let me know.

This PR isn't entirely satisfying as it does result in truncated data in the issue. I tried to mitigate the worst effects of this by including a link back to the originating location. I looked into other options but the tradeoffs didn't seem worth it.

Alternatives

  • Creating a GH issue via post to GH API
    • pros: no limitation on content
    • cons: would come from a central account rather than users' personals
  • Replacing body with a link to a central view of the relevant info in the app
    • pros: no limitations on content, freedom with presentation
    • cons: requires navigating away from GH

related to #1334

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant