Xray-App / xray-maven-plugin

Xray Maven Plugin
BSD 3-Clause "New" or "Revised" License
26 stars 12 forks source link

Option to use JIRA issue name instead of issue key for output file names #68

Open serdarbuyuran opened 9 months ago

serdarbuyuran commented 9 months ago

Hello,

I am currently using the mvn xray:export-features command to export features and scenarios from JIRA using the Xray plugin. The output file names are in the format 1_XRAY-3115.feature where XRAY-3115 is the issue key.

However, I want to replace the issue key in the file name with the corresponding JIRA issue name. In other words, instead of 1_XRAY-3115.feature, I want the file name to represent the actual JIRA issue name. This would provide a more meaningful context when looking at the output files.

Could you consider adding a feature that allows the customization of the output file names in this way?

Thank you for considering my request.

bitcoder commented 8 months ago

Hi @serdarbuyuran , currently this plugin gets the generated features from Xray API; so it's Xray that generates the name according with the logic in the product, which has some rules if you look at Xray's documentation. Implementing your feature would be hard for several reasons; the main one is that it would require making API call to Jira's REST API to obtain it after parsing the names that come in the zipped content given by Xray...

orcunbalcilar commented 8 months ago

@bitcoder you are right, but there is already a feature name at the top of each feature file - > Feature: Regression. So we can get this name and rename each feature file I think as a lightweight and alternative solution. This enhancement would be beneficial because xray issue keys makes no sense in terms of naming feature files.

sandeepraina-lenze commented 3 months ago

Hello,

I just checked the same feature with current build and it works provided a simple setting/configuration required to be done in JIRA under Managed Apps for XRay

image

bitcoder commented 3 months ago

Thanks @sandeepraina-lenze ; It's an effect of those 2 settings you have enabled on the instance that you shared on the screenshot.

I think we can close this now; unless further feedback is provided, I'll close it on the next days