Adjust jira skills for handling formatted descriptions#31
Merged
Conversation
Assisted-by: Claude Opus 4.6 Signed-off-by: John Collier <jcollier@redhat.com>
johnmcollier
force-pushed
the
rhdhskillformatdesc
branch
from
c87f3f9 to
1fdaddc
Compare
Assisted-by: Claude Opus 4.6
…dhskillformatdesc
Member
Author
|
@schultzp2020 mind taking a look? |
schultzp2020
requested changes
May 28, 2026
schultzp2020
left a comment
schultzp2020
left a comment
Collaborator
There was a problem hiding this comment.
Nice work on the ADF path — this should fix the formatted-description issue for epics and features.
One thing I noticed: templates.md, acli-commands.md, and support.md still show the old plain-text create flow, and they aren't in this diff. Depending on which file an agent loads, it might still try the broken path. If you have bandwidth, updating those here (or in a quick follow-up) would keep the skill consistent. Happy to pair on a skill-maker audit pass if that's useful.
Test issues RHIDP-14212–14216 are closed.
Member
Author
|
Also addressed your general comment about the old plain-text create flow:
|
johnmcollier
added a commit
to johnmcollier/rhdh-skill
that referenced
this pull request
May 28, 2026
- to-issue.md: story_points → customfield_10028 (field cannot be set via display name on writes) - SKILL.md Gotcha redhat-developer#6: point agents at jira-wiki-to-adf.py instead of hand-rolling ADF - to-epic/feature/issue.md: use $(mktemp) variable for ADF output files for portability - to-epic.md: soften parent link wording — both customfield_10018 and parent.key work; warn only against issuelinks - jira-wiki-to-adf.py: switch to argparse with --help, add encoding="utf-8" on file I/O, remove unused sys import - tests/unit/test_jira_wiki_to_adf.py: 10 unit tests against epic-example.txt (heading, bulletList, taskList, inline marks) - acli-commands.md, templates.md: fix old plain-text create flow to use ADF conversion step Assisted-by: claude-sonnet-4-6
johnmcollier
added a commit
to johnmcollier/rhdh-skill
that referenced
this pull request
May 28, 2026
- to-issue.md: story_points → customfield_10028 (field cannot be set via display name on writes) - SKILL.md Gotcha redhat-developer#6: point agents at jira-wiki-to-adf.py instead of hand-rolling ADF - to-epic/feature/issue.md: use $(mktemp) variable for ADF output files for portability - to-epic.md: soften parent link wording — both customfield_10018 and parent.key work; warn only against issuelinks - jira-wiki-to-adf.py: switch to argparse with --help, add encoding="utf-8" on file I/O, remove unused sys import - tests/unit/test_jira_wiki_to_adf.py: 10 unit tests against epic-example.txt (heading, bulletList, taskList, inline marks) - acli-commands.md, templates.md: fix old plain-text create flow to use ADF conversion step Assisted-by: claude-sonnet-4-6
johnmcollier
force-pushed
the
rhdhskillformatdesc
branch
from
adc6329 to
4298e7e
Compare
johnmcollier
added a commit
to johnmcollier/rhdh-skill
that referenced
this pull request
May 28, 2026
- to-issue.md: story_points → customfield_10028 (field cannot be set via display name on writes) - SKILL.md Gotcha redhat-developer#6: point agents at jira-wiki-to-adf.py instead of hand-rolling ADF - to-epic/feature/issue.md: use $(mktemp) variable for ADF output files for portability - to-epic/feature/issue.md: drop /tmp/ prefix from converter input paths (bare filename works cross-platform) - to-epic.md: soften parent link wording — both customfield_10018 and parent.key work; warn only against issuelinks - jira-wiki-to-adf.py: switch to argparse with --help, add encoding="utf-8" on file I/O, remove unused sys import - tests/unit/test_jira_wiki_to_adf.py: 10 unit tests against epic-example.txt (heading, bulletList, taskList, inline marks) - acli-commands.md, templates.md, support.md: fix old plain-text create flow to use ADF conversion step Assisted-by: claude-sonnet-4-6
johnmcollier
force-pushed
the
rhdhskillformatdesc
branch
from
4298e7e to
b873af6
Compare
- to-issue.md: story_points → customfield_10028 (field cannot be set via display name on writes) - SKILL.md Gotcha redhat-developer#6: point agents at jira-wiki-to-adf.py instead of hand-rolling ADF - to-epic/feature/issue.md: use $(mktemp) variable for ADF output files for portability - to-epic/feature/issue.md: drop /tmp/ prefix from converter input paths (bare filename works cross-platform) - to-epic.md: soften parent link wording — both customfield_10018 and parent.key work; warn only against issuelinks - jira-wiki-to-adf.py: switch to argparse with --help, add encoding="utf-8" on file I/O, remove unused sys import - tests/unit/test_jira_wiki_to_adf.py: 10 unit tests against epic-example.txt (heading, bulletList, taskList, inline marks) - acli-commands.md, templates.md, support.md: fix old plain-text create flow to use ADF conversion step Assisted-by: claude-sonnet-4-6
johnmcollier
force-pushed
the
rhdhskillformatdesc
branch
from
b873af6 to
92ad8fe
Compare
durandom
approved these changes
Jun 1, 2026
durandom
left a comment
durandom
left a comment
Member
There was a problem hiding this comment.
Clean, well-tested stdlib-only converter that solves a real problem. All prior review feedback addressed. LGTM.
3 non-blocking suggestions for follow-up:
- Italic regex
_([^_\n]+)_can match mid-word underscores (e.g.field_name_here) — worth a docstring note if extending the converter later test_cli_stdoutdoesn't actually test the CLI subprocess — consider renaming totest_json_round_trip- Multi-level lists not supported — documented limitation, acceptable for current scope
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I was using the
rhdh-jiraskills to populate child epics for a Feature, and found that the formatted descriptions (e.g.h1 Epic Goal) were being formatted at all. I remember hitting something similar when interacting with the Jira MCP server.In short, when interacting with issues via the Jira API, Jira expects issue descriptions to be formatted in the Atlassian Document Format (ADF).
I debated how to best handle this, ADF is a verbose JSON-based format (see here for an example), so maintaining it could be a pain. Claude came up with a Python script that can convert the jira markdown to ADF, but I'm undecided if this is the best approach, open to suggestions.
Otherwise, this PR makes a couple small changes based on how the
acliparameters work for setting certain issue fields.