Add Zip comments to support archives
What does this MR do and why?
A small tweak to the support logs and FileHelper.make_compressed_archive()
, just an idea I had after downloading backups for an ark server and it having an inline comment in it's archive.
This will add an 'optional' comments argument to the FileHelper.make_compressed_archive()
(so we can use it elsewhere if we want, could maybe add for backups too),
then use this new argument to apply system info to the support archive comments.
I have retained the original support text file after reading the following comment:
Make version file .txt when we download it for support
Most people have a default editor for .txt also more mobile friendly...
But if the assigned reviewer who initially designed the support log system feels this is no longer necessary with my tweak then I can remove the accompaniment file.
Screenshots or screen recordings
How to set up and validate locally
- Checkout and launch crafty instance
- Download support logs
- open archive in zip viewer
- (Optional: Use another function that uses this FileHelper, It doesn't break things w/o comment, as is optional
)
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
Have you checked this doesn't interfere/conflict/duplicate someone elses work? -
Have you fully tested your changes? -
Have you resolved any lint issues? -
Have you assigned a reviewer? -
Have you applied correct labels?