Skip to content

Github action to check for new added packages size on bundlephobia

License

Notifications You must be signed in to change notification settings

carlesnunez/check-my-bundlephobia

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Check my bundlephobia

Check my bundlephobia is a github action that will check for your code changes on a PR and will left a comment with the different sizes.

How to use it

name: "check my bundlephobia"
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
jobs:
  bundlecheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: carlesnunez/check-my-bundlephobia@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          strict: true
          threshold: 500
          ignore-dev-dependencies: true

Options

name description required type default
repo-token used by the action in order to perform PR reviews true
strict If true will reject the PR if threshold is exceded false Boolean false
threshold Max package size in bytes false String 500
ignore-dev-dependencies Ignore devDependencies so that to not be checked false Boolean false