https://github.com/carlesnunez/check-my-bundlephobia

Github action to check for new added packages size on bundlephobia
https://github.com/carlesnunez/check-my-bundlephobia

Last synced: about 2 months ago
JSON representation

Github action to check for new added packages size on bundlephobia

• Host: GitHub
• URL: https://github.com/carlesnunez/check-my-bundlephobia
• Owner: carlesnunez
• License: mit
• Created: 2020-03-05T23:26:11.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T04:38:35.000Z (over 1 year ago)
• Last Synced: 2024-11-15T02:47:28.712Z (2 months ago)
• Language: JavaScript
• Size: 1.14 MB
• Stars: 51
• Watchers: 2
• Forks: 9
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Check bundlephobia - Comments new and modified package size according to bundlephobia.io website and rejects PR on threshold surpassed. (Community Resources / Monitoring)
• fucking-awesome-actions - Check bundlephobia - Comments new and modified package size according to bundlephobia.io website and rejects PR on threshold surpassed. (Community Resources / Monitoring)
• awesome-workflows - Check bundlephobia - Comments new and modified package size according to bundlephobia.io website and rejects PR on threshold surpassed. (Community Resources / Monitoring)

README

        
# 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

```yml

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     |