Just a heads up: On March 24, 2025, starting at 4:30pm CDT / 19:30 UTC, the site will be undergoing scheduled maintenance for a few hours. During this time, the site might be unavailable for a short while. Thanks for your patience.
×Dear community,
As a user of Jira, who creates new issues, I want to be able to write gherkin syntax code (and highlight it that way) in the Description field of a Story.
I found that Description field by default users Wiki Style Renderer and this renderer supports many languages, specified here - https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=advanced
I want to add more languages to the code formatting, such that when I create an issue as shown in picture below....
...shows up formatted similar to what is shown below, after saving /creating it:
How do I enable this in Jira?
(I have admin rights of the Jira instance)
Thanks!
Hello @[deleted]
Welcome to the Atlassian Community!
Unfortunately, The wiki-style renderer of Jira application can not be configured with the Gherkin syntax code to highlight the code in the way you want. We have the following feature request to get this implemented in Jira renderers:
Include Gherkin (Cucumber) Syntax Highlighting
Feel free to vote and watch the suggestion to increase its priority and also receive notifications about any updates.
For now, the supported languages are:
actionscript, ada, applescript, bash, c, c#, c++, cpp, css, erlang, go, groovy, haskell, html, java, javascript, js, json, lua, none, nyan, objc, perl, php, python, r, rainbow, ruby, scala, sh, sql, swift, visualbasic, xml, yaml
Let us know if you have any questions.
Thanks Petter for a clear answer.
The feature request you quoted had been "Gathering Interest" for over 2 years now. What is the criteria to get it moving to "Reviewing" and further to "In Progress"?
I would like to know if I can influence it (more than just by voting for it, which I've already done).
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Hi @[deleted]
While you can't write Gherkin in the description of your Jira issue there are a number of Apps in the Atlassian Marketplace that will allow you to write Gherkin in a separate panel on Jira issues. Some of the more advanced App's in this space can even commit and synchronize the Gherkin written in Jira to Bitbucket, GitHub and GitLab.
I created Behave Pro, one of the more advanced apps, and I have been coaching BDD to teams for over 10 years. If you are looking for more functionality or want any advice I would be happy to chat.
All the best
Alan
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Hi Alan,
Thanks for responding. I have identified many plugins that could do the job, but my company's decision is not to invest in a plugin.
REASON: At the moment there is rather a small community (about 10 people) who are keen in introducing BDD, in the company. But we have a 600 user Jira license and atlassian licensing framework only has the capability to enable plugins for the whole user base and hence forces you to purchase plugins for the entire user base (in this case 600 users). This is a big deterrent for the company to invest in a atlassian marketplace plugin that at least for the first 6 months to 1 year will be used only by a very few people.
Hence I am exploring ways to meet the need for writing and managing feature files for as long as the company stays with Jira.
Thanks again!
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Hi @[deleted]
I understand the situation on licensing for a small team inside a larger Jira instance and I've had a request for per-project licensing for Jira Cloud open since 2014 with no progress. As Marketplace partners, we can't even offer a discount code on Jira Cloud for such situations but we have done deals where we bundle BDD training to help around licensing.
Putting on my BDD coaches hat on...
If the product owners and business stakeholders are involved in BDD but you are also automating using Cucumber, SpecFlow or another BDD automation tool, I would recommend only capturing the Gherkin in one place and that should be source control rather than Jira. The reason for this copying the changes between source control and Jira often doesn't happen and it can become confusing for everyone reading different copies or versions of the Gherkin.
I fully believe the business should be involved in BDD to build that 'Shared understanding' before development starts for a user story, to make the Gherkin accessible from source control you could use a framework like Serenity (Cucumbers HTML reports would work) to publish them as a website for the business-facing people and use tags on each scenario to reference the Jira issues.
This solution does mean conversations would need to be captured directly in source control instead of Jira, but if you currently use a technique like Example Mapping for user story discussions I would capture a screenshot (if remote or WFH) or a photo of the sticky note examples from the session and attach those to the Jira Issue until the Gherkin is written up in source control.
I know this solution requires some extra work and it's a trade-off, but it should help around BDD.
All the best
Alan
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Hi @[deleted] ! Tks to ask this to Atlassian! I Have the same request.
I think thats a simple feature. Notepad++ possibilite us to put a .txt doc and resolve it...
Until Atlassian resolve this, maybe we can use the "panel" with bold or similar.
Look "panel" at : https://jira.gft.com/secure/WikiRendererHelpAction.jspa?section=advanced
I put this in all stories:
{panel:title=Feature: Some terse yet descriptive text of what is desired
|borderStyle=dashed|borderColor=#ccc|titleBGColor=#F7D6C1|bgColor=#FFFFCE}
*In order* to realize a named business value
*As an* explicit system actor
*I want* to gain some beneficial outcome which furthers the goal
*Scenario:* Some determinable business situation
*Given* some precondition
*And* some other precondition
*When* some action by the actor
*And* some other action
*And* yet another action
*Then* some testable outcome is achieved
*And* something else we can check happens too
{panel}
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
How hard it could be to add this formating at last????
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.