This project is no longer being actively developed. Please use https://github.com/ai/size-limit instead.
This action will calculate the size of your assets for each PR and comment when the filesize is bigger than the one in the master branch.
The defaults are set so that most projects work out of the box (e.g. Laravel projects) but it is easily tweaked to work with any web framework.
Create a file named .github/workflows/simple-size-check.yml
in your repo and add the following:
name: Simple Asset Size Reporter
on: [pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2-beta
with:
fetch-depth: 0
- uses: chrysanthos/[email protected]
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
files: '["public/js/*.js", "public/css/*.css"]'
with-same: 'false'
build-assets: 'false'
The github token to be used.
The asset files to be checked. This needs to be a json encoded array of regex paths.
Defaults to: '["public/js/.js", "public/css/.css"]'.
In case you do not commit the compiled assets inside your repository and need compiling this the place to put your build command.
When this is set to auto
it will detect whether you use npm
or yarn
and run the appropriate command (i.e. npm run prod
or yarn run prod
) to build your assets.
If you want the report to include the files that their size did not change set this to 'true'.
name: Simple Asset Size Reporter
on: [pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2-beta
with:
fetch-depth: 0
- uses: chrysanthos/[email protected]
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
files: '["public/js/*.js", "public/css/*.css"]'
with-same: 'true'
build-assets: 'npm run prod'
Initial work: simplabs/ember-asset-size-action
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.