# bundle-size-action

**Repository Path**: mirrors_mikeal/bundle-size-action

## Basic Information

- **Project Name**: bundle-size-action
- **Description**: Calculate the bundle size of your module. Useful for GitHub Actions.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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)