chrysanthos/simple-asset-size-reporter

A Github Action to easily identify asset size increase (or decrease) in your PRs

Abandoned

This project is no longer being actively developed. Please use https://github.com/ai/size-limit instead.

Simple Asset Size Reporter

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.

Example usage

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'

Usage

repo-token (Required)

The github token to be used.

files (Optional)

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"]'.

build-assets (Optional)

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.

with-same (Optional)

If you want the report to include the files that their size did not change set this to 'true'.

Full example

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'

Credits

Initial work: simplabs/ember-asset-size-action

License

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.

simple-asset-size-reporter's Issues

Update dependencies

Error when running github action

I am seeing the following error:

 Run chrysanthos/[email protected]
2s
    build-assets: false
Run chrysanthos/[email protected]
  with:
    repo-token: ***
    files: ["dist/.js"]
    with-same: false
    build-assets: false
[@octokit/rest] `const Octokit = require("@octokit/rest")` is deprecated. Use `const { Octokit } = require("@octokit/rest")` instead
[@octokit/rest] `const Octokit = require("@octokit/rest")` is deprecated. Use `const { Octokit } = require("@octokit/rest")` instead
/usr/bin/git checkout 60ed245099341642e9714b70b9c0e054f619acdd
Previous HEAD position was 80f95fbc Merge 463a7e29c72a18616f39ead8afe118435775b76c into 60ed245099341642e9714b70b9c0e054f619acdd
HEAD is now at 60ed2450 feat(git actions): add bundle watch (#7)
Could not create a comment automatically.
##[error]body is not defined

I'm not sure how to troubleshoot this. Any help is appreciated.

Add tests