immutable/assets-checker

A Github Action to Analyse your static image files and warns if the size increase the threshold size. It check for .jpg, .svg, .png, .gif, .jpeg, .webp and .riv files.

Assets Check Bot

This repository hosts a simple github action to analyse your repository for static image files when generating a pull request and then warns when it finds images which are over the file-size threshold.

It currently checks all .jpg, .svg, .png, .gif, .jpeg, .webp, and .riv files.

Install

npm i
# or
yarn install

Build

npm run build

Output Stats

Success

Failure

.assets-ignore file

Sometimes its not possible to optimise an image, or you may not need to because you're utilising Biome's inbuilt aws-image-resizer functionality. In cases like these, we can ignore these files by using a .assets-ignore file inside the root of the repository.

The ignore assets name must be add as full path and separate - separate lines:

Usage:

Check Demo.yml for complete configuration(on using github actions)

License

The scripts and documentation in this project are released under the MIT License