allure-docker-service icon indicating copy to clipboard operation
allure-docker-service copied to clipboard

Naming reports

Open eilonreifs opened this issue 4 years ago • 12 comments

Hi, It could be awesome if you will add an option of naming the report when creating it through the API, instead of just giving it arbitrary names (e.g. 1,2,3). It can be very useful for the purpose of preserving the reports for the long term. Thanks!

eilonreifs avatar Dec 22 '20 09:12 eilonreifs

@eilonreifs I could handle an option to do that. I will put it in the backlog. Thanks

fescobar avatar Dec 22 '20 10:12 fescobar

Hi @eilonreifs Regarding your requirement. When you say this: It can be very useful for the purpose of preserving the reports for the long term. Remember there is a limit by default to keep the latest 20 executions (customized to support the limit that you want.) I mean if we store your named report, it will be removed once the limit (20) is reached. Is it something that you mind?

I think if you want to keep the report permanently, maybe we need to create another place to store that report, something like archived_reports. In that way, I will need to create other endpoints to access archived reports and remove them. it would be that something useful for you? Can you explain the use case in detail, please?

fescobar avatar Jan 18 '21 15:01 fescobar

Hi @fescobar , I am aware of the limit. The classic use case of that feature is easily finding the relevant report when looking for a specific date / version, depends on how the developer defines the name. I'm planning on giving names based on the time and date of the report, what will make it possible to access reports from a specific date. Thanks a lot

eilonreifs avatar Jan 20 '21 11:01 eilonreifs

@eilonreifs Ok, let me think about that. Thanks

fescobar avatar Jan 20 '21 11:01 fescobar

It could also be useful to use snapshot names, instead of id or date as well I believe making this as a custom environment option will make it more generic to use

mhd-b avatar Feb 11 '21 13:02 mhd-b

@fescobar If I implement this, it should be like this: 1-your_custom_name,2-your_custom_name . I need to have the index as the first position. what do you think? @mhd-b

fescobar avatar Feb 11 '21 13:02 fescobar

Is it possible to make the report name completely controllable? Does it make sense the presence of an index before your_custom_name? Could it be replaced by another unique value, set by user?

adamakalshchikov avatar Feb 11 '21 13:02 adamakalshchikov

@adamakalshchikov it's not possible to do that. It seems to be an easy change, but with that, I will lose complete control of the reports. Always I need the index.

fescobar avatar Feb 11 '21 13:02 fescobar

+1 for this feature, we are using custom name in format <SERVICE_NAME>_<DATETIME_OF_TESTING> for our reports so even with index digits in front it would be much easier to find required report than just by number.

mobedigg avatar Apr 29 '21 17:04 mobedigg

any update regarding of it? would like to bind it to a build id, it is an increasing integer so there is no way of losing control of the reports

roy-firman avatar Feb 13 '22 12:02 roy-firman

Hi @fescobar, +1 for this feature.

  1. Another example of passing id from outside would be to pass BuildName from AzureDevOps and with that make use of the broken Allure Test Reports plugin. But that also requires full control of the report URL.
  2. As for indexes, can you create a 1:1 mapping of indexes to report names somewhere? This is what usually is being done to have ID when a user wants something else)) and it will help to have both last N functionality working and having free naming for reports? Even more simple would be just saving file names in a file row by row and removing lines from begging and adding lines at the end.

UPD: After checking out keepAllureLatestHistory.sh) I understood why not having the ID is so inconvenient =) but I guess it's still doable.

NaZaRKIN123 avatar May 06 '22 13:05 NaZaRKIN123

@fescobar If I implement this, it should be like this: 1-your_custom_name,2-your_custom_name . I need to have the index as the first position. what do you think? @mhd-b

Hi @fescobar, did this option get added?

DonaghM1982 avatar Jul 03 '23 14:07 DonaghM1982