How to ensure code snippets are formatted when editing Jira description via an automation

Question

Hi everyone,

I'm adding some default descriptions to tickets via automations and am trying to get some text formatted as an inline code snippet.

I've tried to use this using the `` characters as specified in this document.

However, when the automation happens, the characters are just formatted as they are.

Does anyone have any idea how I do this?

Vishal Biyani_2pr07j · Answer

@Olie Ryan-George

Try below and see which you like between noformat and code

{noformat} sudo npm install vsoagent-installer -g {noformat}

Example Text

{code:title=example.py|borderStyle=solid}

issue = jira.issue("TEST-123")

comments = issue.fields.comment.comments

for comment in comments:

print(f"Author: {comment.author.displayName}, Comment: {comment.body}")

{code}

Akash Singh_vujl0e · Answer

@Olie Ryan-George

The guide you referred to provides keyboard shortcuts for editing descriptions in Jira. To ensure your automation updates the description correctly, you can refer to this Markdown WikiRenderer guide for assistance:

https:/ /jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=advanced.

For your specific use case, wrapping the shell command in {code:shell}<my code goes here>{code} should resolve the issue.

{code:shell}
   python3 manage.py --do-something
{code}