cwa-website icon indicating copy to clipboard operation
cwa-website copied to clipboard

Heavy screenshot usage in repository (size and number of files)

Open MikeMcC399 opened this issue 2 years ago • 0 comments

Where to find the issue

https://github.com/corona-warn-app/cwa-website/tree/master/src/assets/screenshots

Problem description

The screenshots directory in the cwa-website repository uses a large amount of space and includes a high number of files.

Each app version release causes a complete set of images to be committed to the repository for the combinations iOS/English, Android/English, iOS/German and Android/German. Many of these files have not changed between versions, meaning that there is a high level of duplication.

Metric Screenshots Total web
Size 966 MB / 70% 1.38 GB / 100%
Files 11.296 / 88% 12.881 / 100%

Summary

Screenshots cause ...

  • High use of space in total
  • High number of files in total
  • High number of files in each release PR
    • difficult to review
    • GitHub "Files changed" function in PRs does not work well with so many image files

Suggested change

De-duplicate the screenshot images and use a method where only changed screenshots need to be published.

Advantages

  • Reduce the size and complexity of the repository
  • If only changes need to be published with each release then reviewing the changes will be simpler. Currently more than 600 files are part of each related PR.
  • GitHub "Files changed" for reviewing PRs will work better

MikeMcC399 avatar Apr 06 '22 12:04 MikeMcC399