Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

Detect and convert Jira wiki markup in descriptions #61

@piekstra

Description

@piekstra

Problem

When users provide descriptions using old Jira Server wiki markup syntax (e.g., h2., {{code}}, [text|url]), the text is passed through to Jira Cloud as plain text since the API expects ADF (Atlassian Document Format) or markdown.

This results in tickets with literal h2. Context text instead of proper headings.

Example

Input (wiki markup):

h2. Context
This is some context.

{{my-cli run --flag}}

[GitHub Issue #175|https://github.com/example/repo/issues/175]

Expected (rendered):

  • h2. becomes a heading
  • {{...}} becomes inline code
  • [text|url] becomes a link

Actual:
All markup appears as literal plain text in the ticket.

Proposed Solutions

Option A: Auto-convert wiki markup to markdown
Detect common wiki patterns and convert before submission:

  • h2. Title## Title
  • h3. Title### Title
  • {{code}}`code`
  • [text|url][text](url)
  • {code}..{code}```...```

Option B: Warn on wiki markup detection
If wiki patterns are detected, warn the user:

Warning: Description appears to contain Jira wiki markup (h2., {{...}}).
Jira Cloud expects markdown. Use --force to submit anyway.

Context

This was discovered when a ticket was created with wiki markup and rendered incorrectly. The CLI successfully accepts markdown, so the fix is straightforward for users who know - but a conversion or warning would improve UX.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions