Skip to content

docs: document Jira Markdown comment memory-growth workaround - #26

Draft
SourceCode wants to merge 1 commit into
atlassian:mainfrom
SourceCode:docs/25-jira-comment-memory-workaround
Draft

SourceCode wants to merge 1 commit into
atlassian:mainfrom
SourceCode:docs/25-jira-comment-memory-workaround

Conversation

@SourceCode

Copy link
Copy Markdown

Summary

An indented Markdown pipe table under a list item can make TWG CLI 1.3.5 hang and consume unbounded memory before posting a Jira comment. Document the verified workaround: end the list and put the table and following paragraph at column zero.

Adds a sanitized reproducer, bounded measurements, implementation regression requirements, and a troubleshooting link from SUPPORT.md.

Related to #25. This documentation PR does not patch the executable or close the issue; the implementation source is absent from this public repository.

Public Safety Checklist

  • No tokens, credentials, cookies, auth files, or .env files.
  • No private Jira, Confluence, Bitbucket, infrastructure, pipeline, or customer URLs.
  • No customer data, proprietary content, or internal runbook detail.
  • No generated artifacts or plugin/release metadata changed.

Verification

  • Installed TWG CLI 1.3.5, macOS arm64: sanitized indented input exceeded the 512 MiB watchdog threshold in 1.41 seconds; the dedented variant reached the expected HTTP 404 in 0.65 seconds.
  • Used deliberately nonexistent numeric issue ID 0, so no comment was posted and no Jira issue changed.
  • Reporter-provided original input reproduced the same behavior in a separate bounded check.
  • Offline dedented conversion preserved one table, all nine data cells, and all three list items.
  • Issue-template YAML validation, required-file checks, and git diff --check pass.
  • Changed files pass public-safety scans. The repository-wide sensitive-pattern scan flags two pre-existing auth.conf references in the benchmark runner; this PR does not alter them.

@atlassian-cla-bot

Copy link
Copy Markdown

Thank you for your submission! Like many open source projects, we ask that you sign our CLA (Contributor License Agreement) before we can accept your contribution.
If your email is listed below, please ensure that you sign the CLA with the same email address.

The following users still need to sign our CLA:
❌SourceCode

Already signed the CLA? To re-check, try refreshing the page.

This branch has not been deployed

No deployments
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