https://github.com/mikeal/bundle-size-action

Calculate the bundle size of your module. Useful for GitHub Actions.
https://github.com/mikeal/bundle-size-action

Last synced: 27 days ago
JSON representation

Calculate the bundle size of your module. Useful for GitHub Actions.

• Host: GitHub
• URL: https://github.com/mikeal/bundle-size-action
• Owner: mikeal
• Created: 2019-08-19T19:15:57.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-10T04:47:32.000Z (about 4 years ago)
• Last Synced: 2024-10-06T18:57:11.316Z (about 1 month ago)
• Language: JavaScript
• Size: 11.7 KB
• Stars: 28
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `bundle-size-action`

In order to add bundle size badges to your readme automatically, add the following GitHub Action.

```

- uses: mikeal/bundle-size-action@master

- uses: mikeal/publish-to-github-action@master

  env:

    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

The first action creates a new bundle, minifies it, and inserts/modifies the badges in the readme. The second action 

publishes changed files back to GitHub, which in this case is the `README.md` that was just modified.

You probably want to run this at the end of your regular build/test cycle on master.

Known projects using this are:

* [bent](https://github.com/mikeal/bent)

* [bytesish](https://github.com/mikeal/bytesish)

* [digestif](https://github.com/mikeal/digestif)