{"id":19417204,"url":"https://github.com/effector/size-compare","last_synced_at":"2025-04-24T13:33:27.425Z","repository":{"id":60869333,"uuid":"546119535","full_name":"effector/size-compare","owner":"effector","description":"Compare size changes of your bundle over the time and new Pull Requests.","archived":false,"fork":false,"pushed_at":"2023-08-03T04:22:40.000Z","size":566,"stargazers_count":11,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T18:42:59.478Z","etag":null,"topics":["code-quality","github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/effector.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-05T14:58:44.000Z","updated_at":"2023-05-21T11:00:00.000Z","dependencies_parsed_at":"2023-01-04T21:30:29.756Z","dependency_job_id":null,"html_url":"https://github.com/effector/size-compare","commit_stats":{"total_commits":68,"total_committers":1,"mean_commits":68.0,"dds":0.0,"last_synced_commit":"199dbebb704ac6e1d88e3a90e31300d3b1dfa941"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/effector%2Fsize-compare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/effector%2Fsize-compare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/effector%2Fsize-compare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/effector%2Fsize-compare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/effector","download_url":"https://codeload.github.com/effector/size-compare/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223954798,"owners_count":17231189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-quality","github-actions"],"created_at":"2024-11-10T13:08:06.240Z","updated_at":"2024-11-10T13:08:07.024Z","avatar_url":"https://github.com/effector.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# size-compare\n\nCompare size changes of your bundle over the time and new Pull Requests.\n\n## Usage\n\n1. [Create new GIST](https://gist.github.com/) and add `README.md` file with any content.\n2. Add ID of the gist into Secrets as `SIZE_HISTORY_GIST_ID`.\n3. [Create personal access token](https://github.com/settings/tokens) with `gist` permission. **Copy the token**.\n4. Add the token into Secrets as `SIZE_COMPARE_TOKEN`.\n5. Create new Workflow file `.github/workflows/size-compare.yml`:\n\n```yaml\nname: SizeCompare CI\n\non:\n  push:\n    branches:\n      - main\n  pull_request:\n    types: [opened, reopened, synchronize, ready_for_review]\n  workflow_dispatch:\n\njobs:\n  size-compare:\n    runs-on: ubuntu-latest\n    steps:\n      - name: 🛎️ Checkout\n        uses: actions/checkout@v3\n\n      # Add here your setup, installation, and build steps\n\n      - name: 🚛 Size compare\n        uses: effector/size-compare@v1.1.0\n        with:\n          gist_id: ${{ secrets.SIZE_HISTORY_GIST_ID }}\n          gist_token: ${{ secrets.SIZE_COMPARE_TOKEN }}\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          files: |\n            dist/**.js\n            !dist/**.js.map\n```\n\n## Inputs\n\n| Name           | Required | Description                                                                                                                     |\n| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `gist_id`      | Yes      | Identifier of the GIST to save size history to                                                                                  |\n| `gist_token`   | No       | Personal Access Token to read/write hist. If not passed `github_token` will be used. Useful for PRs from external contributors. |\n| `github_token` | Yes      | Token used to post comments for PRs.                                                                                            |\n| `files`        | Yes      | List of [glob patterns](https://github.com/actions/toolkit/tree/main/packages/glob#patterns) of files must be checked for size  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feffector%2Fsize-compare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feffector%2Fsize-compare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feffector%2Fsize-compare/lists"}